Skip to content

Commit

Permalink
refactor: remove deprecated function
Browse files Browse the repository at this point in the history
`_embed` is deprecated in favour of `time_delay_embedding`

BREAKING CHANGE:
  • Loading branch information
nikdon committed Jul 6, 2024
1 parent 0a8d1ff commit f2c6581
Showing 1 changed file with 0 additions and 25 deletions.
25 changes: 0 additions & 25 deletions pyentrp/entropy.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,6 @@
import numpy as np


def _embed(x, order=3, delay=1):
"""
Time-delay embedding.
Parameters
----------
x : 1d-array, shape (n_times)
Time series
order : int
Embedding dimension (order)
delay : int
Delay.
Returns
-------
embedded : ndarray, shape (n_times - (order - 1) * delay, order)
Embedded time-series.
Notes
-----
For deprecation in next major release. Use `time_delay_embedding` instead
"""
return time_delay_embedding(x, order, delay)


def time_delay_embedding(time_series, embedding_dimension, delay=1):
"""
Time-delayed embedding.
Expand Down

0 comments on commit f2c6581

Please sign in to comment.