Enum basic_dsp::ErrorReason
[−]
[src]
pub enum ErrorReason { VectorsMustHaveTheSameSize, VectorMetaDataMustAgree, VectorMustBeComplex, VectorMustBeReal, VectorMustBeInTimeDomain, VectorMustBeInFrquencyDomain, InvalidArgumentLength, VectorMustBeConjSymmetric, VectorMustHaveAnOddLength, ArgumentFunctionMustBeSymmetric, }
Enumeration of all error reasons
Variants
VectorsMustHaveTheSameSize
The operations requires all vectors to have the same size,
in most cases this means that the following must be true:
self.len()
== argument.len()
VectorMetaDataMustAgree
The operations requires all vectors to have the same meta data
in most cases this means that the following must be true:
self.is_complex()
== argument.is_complex()
&&
self.domain()
== argument.domain()
&&
self.delta()
== argument.domain()
;
Consider to convert one of the vectors so that this conidition is true.
The necessary operations may include FFT/IFFT, complex/real conversion and resampling.
VectorMustBeComplex
The operation requires the vector to be complex.
VectorMustBeReal
The operation requires the vector to be real.
VectorMustBeInTimeDomain
The operation requires the vector to be in time domain.
VectorMustBeInFrquencyDomain
The operation requires the vector to be in frequency domain.
InvalidArgumentLength
The arguments have an invalid length to perform the operation. The operations documentation should have more information about the requirements. Please open a defect if this isn't the case.
VectorMustBeConjSymmetric
The operations is only valid if the data vector contains half of a symmetric spectrum.
The symmetry definition follows soon however more important is that the element at 0 Hz
which happens to be the first vector element must be real. This is actually violated
if this error message appears and the rest of the definition is only listed here for
completness.
The required symmetry is that for every point vector[x].conj() == vector[-x]
(pseudocode)
where x
is the x-axis position relativ to 0Hz and conj
is the complex conjungate.
VectorMustHaveAnOddLength
self.points()
must be an odd number.
ArgumentFunctionMustBeSymmetric
The function passed as argument must be symmetric
Trait Implementations
impl Copy for ErrorReason
[src]
impl Clone for ErrorReason
[src]
fn clone(&self) -> ErrorReason
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl PartialEq for ErrorReason
[src]
fn eq(&self, __arg_0: &ErrorReason) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0
This method tests for !=
.