# Crate basic_dsp_vector[−][src]

Basic digital signal processing (DSP) operations

Digital signal processing based on real or complex vectors in time or frequency domain. Vectors are expected to typically have a size which is at least in the order of magnitude of a couple of thousand elements. This crate tries to balance between a clear API and performance in terms of processing speed.

Take this example:

let mut vector1 = vec!(1.0, 2.0).to_real_time_vec(); let vector2 = vec!(10.0, 11.0).to_real_time_vec(); vector1.add(&vector2).expect("Ignoring error handling in examples");

If `vector2`

would be a complex or frequency vector then this won't compile. The type mismatch
indicates that a conversation is missing and that this might be a programming mistake. This lib uses
the Rust type system to catch such errors.

DSP algorithms are often executed in loops. If you work with large vectors you typically try to avoid allocating buffers in every iteration. Preallocating buffers is a common practice to safe a little time with every iteration later on, but also to avoid heap fragmentation. At the same time it's a tedious task to calculate the right buffer sizes for all operations. As an attempt to provide a more convenient solution buffer types exist which don't preallocate, but store temporary memory segments so that they can be reused in the next iteration. Here is an example:

let vector = vec!(1.0, 0.0, -0.5, 0.8660254, -0.5, -0.8660254).to_complex_time_vec(); let mut buffer = SingleBuffer::new(); let _ = vector.fft(&mut buffer);

The vector types don't distinguish between the shapes 1xN or Nx1. This is a difference to other
conventions such as in MATLAB or GNU Octave.
The reason for this decision is that most operations are only defined if the shape of the
vector matches. So it appears to be more practical and clearer to implement the few operations
where the arguments can be of different shapes as seperate methods. The methods `mul`

and `dot_product`

are one example for this.

The trait definitions in this lib can look complex and might be overwhelming at the beginning.
There is a wide range of DSP vectors, e.g. a slice can be DSP vector, a boxed array can be a DSP vector,
a standard vector can be a DSP vector and so on. This lib tries to work with all of that and tries
to allow all those different DSP vector types to work together. The price for this flexibility is a more complex
trait definition. As a mental model, this is what the traits are specifiying:
Whenever you have a complex vector in time domain, it's binary operations will work with all other
complex vectors in time domain, but not with real valued vectors or frequency domain vectors.
And the type `GenDspVec`

serves as wild card at compile time since it defers all checks to run time.

## Modules

combined_ops |
This module allows to combine certain operations into one operation. Since one many machines the speed of many DSP operations is limited by the memory bus speed this approach may result in better register and cache usage and thus decrease the pressure on the memory bus. As with all performance hints remember rule number 1: Benchmark your code. This is especially true at this very early state of the library. |

conv_types |
Types around a convolution, see also https://en.wikipedia.org/wiki/Convolution. |

numbers |
Traits from the |

window_functions |
This mod contains a definition for window functions and provides implementations for a
few standard windows. See the |

## Structs

ComplexData |
Marker for types containing complex data. |

DspVec |
A 1xN (one times N elements) or Nx1 data vector as used for most digital signal processing (DSP) operations. |

FixedLenBuffer |
A buffer which gets initalized with a data storage type and then always keeps that. |

FixedLenBufferBurrow |
Buffer borrow type for |

FrequencyData |
Marker for types containing frequency data. |

MultiCoreSettings |
Holds parameters which specify how multiple cores are used to execute an operation. |

NoBuffer |
This type can be used everytime the API asks for a buffer to disable any buffering. |

NoBufferBurrow |
Buffer borrow type for |

NoTradeBufferBurrow |
Buffer borrow type for |

RealData |
Marker for types containing real data. |

RealOrComplexData |
Marker for types containing real or complex data. |

SingleBuffer |
A buffer which stores a single vector and never shrinks. |

SingleBufferBurrow |
Buffer borrow type for |

Statistics |
Statistics about numeric data |

TimeData |
Marker for types containing time data. |

TimeOrFrequencyData |
Marker for types containing time or frequency data. |

TypeMetaData |
Holds meta data about a type. |

## Enums

DataDomain |
The domain of a data vector |

ErrorReason |
Enumeration of all error reasons |

PaddingOption |
An option which defines how a vector should be padded |

## Constants

STATS_VEC_CAPACTIY |
The maximum |

## Traits

ApproximatedOps |
Recommended to be only used with the CPU feature flags |

Buffer |
A buffer which can be used by other types. Types will call buffers to create new arrays. A buffer may can implement any buffering strategy. |

BufferBorrow |
A "slice-like" type which also allows to |

ComplexIndex |
Like |

ComplexIndexMut |
Like |

ComplexNumberSpace |
Trait for types containing complex data. |

ComplexOps |
Operations on complex types. |

ComplexToRealGetterOps |
Defines getters to get real data from complex types. |

ComplexToRealSetterOps |
Defines setters to create complex data from real data. |

ComplexToRealTransformsOps |
Defines transformations from complex to real number space. |

ComplexToRealTransformsOpsBuffered |
Defines transformations from complex to real number space. |

Convolution |
Provides a convolution operations. |

ConvolutionOps |
Provides a convolution operation for types which at some point are slice based. |

CrossCorrelationArgumentOps |
Cross-correlation of data vectors. See also https://en.wikipedia.org/wiki/Cross-correlation |

CrossCorrelationOps |
A trait to calculate the cross correlation. |

DiffSumOps |
A trait to calculate the diff (1st derivative in a discrete number space) or cumulative sum (integral in a discrete number space). |

Domain |
Domain (time or frequency) information. |

DotProductOps |
An operation which multiplies each vector element with a constant |

ElementaryOps |
Elementary algebra on types: addition, subtraction, multiplication and division |

ElementaryWrapAroundOps |
Elementary algebra on types where the argument might contain less data points than |

FrequencyDomain |
Trait for types containing frequency domain data. |

FrequencyDomainOperations |
Defines all operations which are valid on |

FrequencyMultiplication |
Provides a frequency response multiplication operations. |

FrequencyToTimeDomainOperations |
Defines all operations which are valid on |

FromVector |
Retrieves the underlying storage from a vector. |

GetMetaData |
Gets the meta data of a type. This can be used to create a new type with the same meta data. |

InsertZerosOps |
A trait to insert zeros into the data at some specified positions. |

InsertZerosOpsBuffered |
A trait to insert zeros into the data at some specified positions. A buffer is used for types which can't be resized and/or to speed up the calculation. |

InterleaveToVector |
Conversion from two instances of a generic data type into a dsp vector with complex data. |

InterpolationOps |
Provides interpolation operations for real and complex data vectors. |

MapAggregateOps |
Operations which allow to iterate over the vector and to derive results. |

MapInplaceOps |
Operations which allow to iterate over the vector and to derive results or to change the vector. |

MergeOps |
Merges several pieces of equal size into one data chunk. |

MetaData |
A trait which provides information about number space and domain. |

ModuloOps |
Operations on real types. |

NumberSpace |
Number space (real or complex) information. |

OffsetOps |
An operation which adds a constant to each vector element |

PosEq |
Expresses at compile time that two classes could potentially represent the same number space or domain. |

PowerOps |
Roots, powers, exponentials and logarithms. |

PreciseDotProductOps |
An operation which multiplies each vector element with a constant |

PreciseStatisticsOps |
Offers the same functionality as the |

PreciseStatisticsSplitOps |
Offers the same functionality as the |

PreciseStats |
A trait for statistics which allows to add new values in a way so that the numerical uncertainty has less impact on the final results. |

PreciseSumOps |
Offers the same functionality as the |

RealInterpolationOps |
Provides interpolation operations which are only applicable for real data vectors. |

RealNumberSpace |
Trait for types containing real data. |

RealOps |
Operations on real types. |

RealToComplexTransformsOps |
Defines transformations from real to complex number space. |

RealToComplexTransformsOpsBuffered |
Defines transformations from real to complex number space. |

RededicateForceOps |
This trait allows to change a data type and performs the Conversion
without any checks. |

RededicateOps |
This trait allows to change a data type. The operations will
convert a type to a different one and set |

RededicateToOps |
This trait allows to change a data type. The operations will
convert a type to a different one and set |

ReorganizeDataOps |
This trait allows to reorganize the data by changing positions of the individual elements. |

Resize |
A trait for storage types which are known to have the capability to increase their capacity. |

ResizeBufferedOps |
Operations to resize a data type. |

ResizeOps |
Operations to resize a data type. |

ScaleOps |
An operation which multiplies each vector element with a constant |

SplitOps |
Splits the data into several smaller pieces of equal size. |

StatisticsOps |
This trait offers operations to calculate statistics about the data in a type. |

StatisticsSplitOps |
This trait offers operations to calculate statistics about the data in a type. |

Stats |
Operations on statistics. |

SumOps |
Offers operations to calculate the sum or the sum of squares. |

SymmetricFrequencyToTimeDomainOperations |
Defines all operations which are valid on |

SymmetricTimeToFrequencyDomainOperations |
Defines all operations which are valid on |

TimeDomain |
Trait for types containing time domain data. |

TimeDomainOperations |
Defines all operations which are valid on |

TimeToFrequencyDomainOperations |
Defines all operations which are valid on |

ToComplexResult |
Specifies what the the result is if a type is transformed to complex numbers. |

ToComplexVector |
Conversion from a generic data type into a dsp vector with complex data. |

ToComplexVectorPar |
Conversion from a generic data type into a dsp vector with complex data. |

ToDspVector |
Conversion from a generic data type into a dsp vector which tracks
its meta information (domain and number space)
only at runtime. See |

ToDspVectorPar |
Conversion from a generic data type into a dsp vector which tracks
its meta information (domain and number space)
only at runtime. See |

ToFreqResult |
Specifies what the the result is if a type is transformed to frequency domain. |

ToRealResult |
Specifies what the the result is if a type is transformed to real numbers. |

ToRealTimeResult |
Specifies what the the result is if a type is transformed to real numbers in time domain. |

ToRealVector |
Conversion from a generic data type into a dsp vector with real data. |

ToRealVectorPar |
Conversion from a generic data type into a dsp vector with real data. |

ToSlice |
A trait to convert a type into a slice. |

ToSliceMut |
A trait to convert a type into a mutable slice. |

ToTimeResult |
Specifies what the the result is if a type is transformed to time domain. |

TrigOps |
Trigonometry methods. |

Vector |
A trait for vector types. |

## Functions

print_calibration |
Prints debug information about the calibration. The calibration determines when the library will start to spawn threads. If a calibration hasn't been performed yet than calling this function will trigger the calibration. |

## Type Definitions

ComplexFreqVec |
A vector with complex numbers in frequency domain. |

ComplexFreqVec32 |
A vector with complex numbers in frequency domain. |

ComplexFreqVec64 |
A vector with complex numbers in frequency domain. |

ComplexFreqVecSlice32 |
A vector with complex numbers in frequency domain. |

ComplexFreqVecSlice64 |
A vector with complex numbers in frequency domain. |

ComplexTimeVec |
A vector with complex numbers in time domain. |

ComplexTimeVec32 |
A vector with complex numbers in time domain. |

ComplexTimeVec64 |
A vector with complex numbers in time domain. |

ComplexTimeVecSlice32 |
A vector with complex numbers in time domain. |

ComplexTimeVecSlice64 |
A vector with complex numbers in time domain. |

GenDspVec |
A vector with no information about number space or domain at compile time. |

GenDspVec32 |
A vector with no information about number space or domain at compile time. |

GenDspVec64 |
A vector with no information about number space or domain at compile time. |

GenDspVecSlice32 |
A vector with no information about number space or domain at compile time. |

GenDspVecSlice64 |
A vector with no information about number space or domain at compile time. |

RealFreqVec |
A vector with real numbers in frequency domain. |

RealFreqVec32 |
A vector with real numbers in frequency domain. |

RealFreqVec64 |
A vector with real numbers in frequency domain. |

RealFreqVecSlice32 |
A vector with real numbers in frequency domain. |

RealFreqVecSlice64 |
A vector with real numbers in frequency domain. |

RealTimeVec |
A vector with real numbers in time domain. |

RealTimeVec32 |
A vector with real numbers in time domain. |

RealTimeVec64 |
A vector with real numbers in time domain. |

RealTimeVecSlice32 |
A vector with real numbers in time domain. |

RealTimeVecSlice64 |
A vector with real numbers in time domain. |

ScalarResult |
Scalar result or a reason in case of an error. |

StatsVec |
Alias for a vector of any statistical information. |

TransRes |
Result for operations which transform a type (most commonly the type is a vector). On success the transformed type is returned. On failure it contains an error reason and the original type with with invalid data which still can be used in order to avoid memory allocation. |

VoidResult |
Void/nothing in case of success or a reason in case of an error. |