Struct light_curve_feature::features::Amplitude[−][src]

pub struct Amplitude {}

Expand description

Half amplitude of magnitude

$$ \mathrm{amplitude} \equiv \frac{\left( \max{(m)} - \min{(m)} \right)}{2} $$

Depends on: magnitude
Minimum number of observations: 1
Number of features: 1

Example

use light_curve_feature::*;

let amplitude = Amplitude::default();
let time = [0.0, 1.0];  // Doesn't depend on time
let magn = [0.0, 2.0];
let mut ts = TimeSeries::new_without_weight(&time[..], &magn[..]);
assert_eq!(vec![1.0], amplitude.eval(&mut ts).unwrap());

Implementations

impl Amplitude

pub fn new() -> Self

pub fn doc() -> &'static str

Trait Implementations

impl Clone for Amplitude

fn clone(&self) -> Amplitude

Returns a copy of the value. Read more

1.0.0[src]

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Amplitude

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for Amplitude

fn default() -> Amplitude

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Amplitude

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<T> FeatureEvaluator<T> for Amplitude where
T: Float,

fn eval(&self, ts: &mut TimeSeries<'_, T>) -> Result<Vec<T>, EvaluatorError>

Vector of feature values or EvaluatorError

fn get_info(&self) -> &EvaluatorInfo

Get feature evaluator meta-information

fn get_names(&self) -> Vec<&str>

Vector of feature names. The length and feature order corresponds to eval() output Read more

fn get_descriptions(&self) -> Vec<&str>

Vector of feature descriptions. The length and feature order corresponds to eval() output Read more

fn eval_or_fill(&self, ts: &mut TimeSeries<'_, T>, fill_value: T) -> Vec<T>

Returns vector of feature values and fill invalid components with given value

fn size_hint(&self) -> usize

Size of vectors returned by eval(), get_names() and get_descriptions() Read more

fn min_ts_length(&self) -> usize

Minimum time series length required to successfully evaluate feature

fn is_t_required(&self) -> bool

If time array used by the feature

fn is_m_required(&self) -> bool

If magnitude array is used by the feature

fn is_w_required(&self) -> bool

If weight array is used by the feature

fn is_sorting_required(&self) -> bool

If feature requires time-sorting on the input TimeSeries

fn check_ts_length(
&self,
ts: &TimeSeries<'_, T>
) -> Result<usize, EvaluatorError>

Checks if TimeSeries has enough points to evaluate the feature

impl<T> From<Amplitude> for Feature<T> where
T: Float,

fn from(v: Amplitude) -> Feature<T>

Performs the conversion.

impl JsonSchema for Amplitude

fn schema_name() -> String

The name of the generated JSON Schema. Read more

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more

impl Serialize for Amplitude

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<T> TryInto<Amplitude> for Feature<T> where
T: Float,

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Amplitude, <Self as TryInto<Amplitude>>::Error>

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for Amplitude

impl Send for Amplitude

impl Sync for Amplitude

impl Unpin for Amplitude

impl UnwindSafe for Amplitude

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,

type Err = NoError

The error type produced by a failed conversion.

pub fn approx_from(
src: Src
) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.

pub fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject with the default scheme.

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

Approximate the subject with a specific scheme.

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject to a given type with the default scheme.

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.

fn into_as<Dst>(self) -> Dst where
Self: Into<Dst>,

Convert the subject to a given type.

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: TryInto<Dst>,

Attempt to convert the subject to a given type.

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.

impl<T> DynClone for T where
T: Clone,

pub fn __clone_box(&self, Private) -> *mut ()

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<Src> TryFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

pub fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<Src, Dst> TryInto<Dst> for Src where
Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.

pub fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

impl<Src> ValueFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

pub fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.

impl<Src, Dst> ValueInto<Dst> for Src where
Dst: ValueFrom<Src>,

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.

pub fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,