Skip to content

Commit 17590df

Browse files
committed
crossrecurrencematrix -> recurrence_matrix
Closes #33
1 parent 5fb0115 commit 17590df

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/matrices.jl

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ recurrence quantifications", in: Webber, C.L. & N. Marwan (eds.), *Recurrence
185185
Quantification Analysis. Theory and Best Practices*, Springer, pp. 3-43 (2015).
186186
"""
187187
function RecurrenceMatrix(x, ε; kwargs...)
188-
m = crossrecurrencematrix(x, x, ε; kwargs...)
188+
m = recurrence_matrix(x, x, ε; kwargs...)
189189
return RecurrenceMatrix(m)
190190
end
191191

@@ -206,18 +206,18 @@ See [`RecurrenceMatrix`](@ref) for details, references and keywords.
206206
See also: [`JointRecurrenceMatrix`](@ref).
207207
"""
208208
function CrossRecurrenceMatrix(x, y, ε; kwargs...)
209-
m = crossrecurrencematrix(x, y, ε; kwargs...)
209+
m = recurrence_matrix(x, y, ε; kwargs...)
210210
return CrossRecurrenceMatrix(m)
211211
end
212212

213-
function crossrecurrencematrix(x, y, ε; scale=1, fixedrate=false, metric=DEFAULT_METRIC)
213+
function recurrence_matrix(x, y, ε; scale=1, fixedrate=false, metric=DEFAULT_METRIC)
214214
# Check fixed recurrence rate - ε must be within (0, 1)
215215
if fixedrate
216216
sfun = (m) -> quantile(m[:], ε)
217-
return crossrecurrencematrix(x, y, 1; scale=sfun, fixedrate=false, metric=metric)
217+
return recurrence_matrix(x, y, 1; scale=sfun, fixedrate=false, metric=metric)
218218
else
219219
scale_value = _computescale(scale, x, y, metric)
220-
spm = _crossrecurrencematrix(x, y, ε*scale_value, metric)
220+
spm = _recurrence_matrix(x, y, ε*scale_value, metric)
221221
return spm
222222
end
223223
end
@@ -229,17 +229,17 @@ _computescale(scale::Real, args...) = scale
229229

230230
# Internal methods to calculate the matrix:
231231
# If the metric is supplied as a string, get the corresponding Metric from Distances
232-
_crossrecurrencematrix(x, y, ε, metric::String="max") =
233-
_crossrecurrencematrix(x, y, ε, getmetric(metric))
232+
_recurrence_matrix(x, y, ε, metric::String="max") =
233+
_recurrence_matrix(x, y, ε, getmetric(metric))
234234

235235
# Convert the inputs to Datasets (better performance in all cases)
236-
function _crossrecurrencematrix(x::AbstractVecOrMat, y::AbstractVecOrMat,
236+
function _recurrence_matrix(x::AbstractVecOrMat, y::AbstractVecOrMat,
237237
ε, metric::Metric=DEFAULT_METRIC)
238-
return _crossrecurrencematrix(Dataset(x), Dataset(y), ε, metric)
238+
return _recurrence_matrix(Dataset(x), Dataset(y), ε, metric)
239239
end
240240

241241
# Core function
242-
function _crossrecurrencematrix(x::Dataset, y::Dataset, ε, metric::Metric)
242+
function _recurrence_matrix(x::Dataset, y::Dataset, ε, metric::Metric)
243243
x = x.data
244244
y = y.data
245245
rowvals = Vector{Int}()

0 commit comments

Comments
 (0)