Skip to content

Commit 17edc3e

Browse files
committed
small docstring fix
1 parent 8d23c98 commit 17edc3e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/matrices.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ end
2424
Create a matrix with the distances between each pair of points of the
2525
time series `x` and `y` using `metric`.
2626
27-
The time series `x` and `y` can be `Dataset`s or matrices with data points in rows.
27+
The time series `x` and `y` can be `Dataset`s or vectors or matrices with data points
28+
in rows.
2829
The data point dimensions (or number of columns) must be the same for `x` and `y`.
2930
The returned value is a `n×m` matrix, with `n` being the length (or number of rows)
3031
of `x`, and `m` the length of `y`.
@@ -97,7 +98,7 @@ The recurrence matrix is a numeric representation of a "recurrence plot" [1, 2],
9798
in the form of a sparse square matrix of Boolean values.
9899
99100
`x` must be `Dataset` or a Vector or Matrix with data points in rows
100-
(possibly representing and embedded phase, space; see [`embed`](@ref)).
101+
(possibly representing and embedded phase space; see [`embed`](@ref)).
101102
If `d(x[i], x[j]) ≤ ε` (with `d` the distance function),
102103
then the cell `(i, j)` of the matrix will have a `true`
103104
value. The criteria to evaluate distances between data points are defined
@@ -137,7 +138,7 @@ Create a cross recurrence matrix from the time series `x` and `y`.
137138
138139
The cross recurrence matrix is a bivariate extension of the recurrence matrix.
139140
For the time series `x`, `y`, of length `n` and `m`, respectively, it is a
140-
sparse `n×m` matrix of Boolean values, such that if `x[i]y[j] ≤ ε`,
141+
sparse `n×m` matrix of Boolean values, such that if `d(x[i], y[j]) ≤ ε`,
141142
then the cell `(i, j)` of the matrix will have a `true` value.
142143
143144
See [`recurrencematrix`](@ref) for details, references and keywords.

0 commit comments

Comments
 (0)