1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
//! Conversions to and from vectors which serve as constructors.
use super::{
ComplexFreqVec, ComplexTimeVec, DataDomain, Domain, DspVec, GenDspVec, NumberSpace,
RealFreqVec, RealTimeVec, ToSlice, TypeMetaData,
};
use crate::meta;
use crate::multicore_support::MultiCoreSettings;
use crate::numbers::*;
use std::convert::From;
/// Conversion from a generic data type into a dsp vector which tracks
/// its meta information (domain and number space)
/// only at runtime. See `ToRealVector` and
/// `ToComplexVector` for alternatives which track most of the meta data
/// with the type system and therefore avoid runtime errors.
pub trait ToDspVector<T>: Sized + ToSlice<T>
where
T: RealNumber,
{
/// Create a new generic vector.
/// `delta` can be changed after construction with a call of `set_delta`.
///
/// For complex vectors with an odd length the resulting value will have a zero length.
fn to_gen_dsp_vec(self, is_complex: bool, domain: DataDomain) -> GenDspVec<Self, T>;
/// Create a new vector from the given meta data. The meta data can be
/// retrieved from an existing vector. If no existing vector is available
/// then one of the other constructor methods should be used.
fn to_dsp_vec<N, D>(self, meta_data: &TypeMetaData<T, N, D>) -> DspVec<Self, T, N, D>
where
N: NumberSpace,
D: Domain;
}
/// Conversion from a generic data type into a dsp vector with real data.
pub trait ToRealVector<T>: Sized + ToSlice<T>
where
T: RealNumber,
{
/// Create a new vector in real number space and time domain.
/// `delta` can be changed after construction with a call of `set_delta`.
///
/// ```
/// # extern crate num_complex;
/// use basic_dsp_vector::*;
/// # use num_complex::Complex;
/// let mut vec = Vec::with_capacity(10);
/// vec.push(1.0);
/// vec.push(2.0);
/// assert_eq!(2, vec.len());
/// assert_eq!(10, vec.capacity());
/// let vec = vec.to_real_time_vec();
/// assert_eq!(2, vec.points());
/// assert_eq!(2, vec.len());
/// assert_eq!(10, vec.alloc_len());
/// ```
fn to_real_time_vec(self) -> RealTimeVec<Self, T>;
/// Create a new vector in real number space and frequency domain.
/// `delta` can be changed after construction with a call of `set_delta`.
///
/// ```
/// # extern crate num_complex;
/// use basic_dsp_vector::*;
/// # use num_complex::Complex;
/// let mut vec = Vec::with_capacity(10);
/// vec.push(1.0);
/// vec.push(2.0);
/// assert_eq!(2, vec.len());
/// assert_eq!(10, vec.capacity());
/// let vec = vec.to_real_freq_vec();
/// assert_eq!(2, vec.points());
/// assert_eq!(2, vec.len());
/// assert_eq!(10, vec.alloc_len());
/// ```
fn to_real_freq_vec(self) -> RealFreqVec<Self, T>;
}
/// Conversion from a generic data type into a dsp vector with complex data.
pub trait ToComplexVector<S, T>
where
S: Sized + ToSlice<T>,
T: RealNumber,
{
/// Create a new vector in complex number space and time domain.
/// `delta` can be changed after construction with a call of `set_delta`.
///
/// For complex vectors with an odd length the resulting value will have a zero length.
///
/// ```
/// # extern crate num_complex;
/// use basic_dsp_vector::*;
/// # use num_complex::Complex;
/// let mut vec = Vec::with_capacity(10);
/// vec.push(Complex::new(1.0, 2.0));
/// vec.push(Complex::new(3.0, 4.0));
/// assert_eq!(2, vec.len());
/// assert_eq!(10, vec.capacity());
/// let vec = vec.to_complex_time_vec();
/// assert_eq!(2, vec.points());
/// assert_eq!(4, vec.len());
/// assert_eq!(20, vec.alloc_len());
/// ```
fn to_complex_time_vec(self) -> ComplexTimeVec<S, T>;
/// Create a new vector in complex number space and frequency domain.
/// `delta` can be changed after construction with a call of `set_delta`.
///
/// For complex vectors with an odd length the resulting value will have a zero length.
///
/// ```
/// # extern crate num_complex;
/// use basic_dsp_vector::*;
/// # use num_complex::Complex;
/// let mut vec = Vec::with_capacity(10);
/// vec.push(1.0);
/// vec.push(2.0);
/// vec.push(3.0);
/// vec.push(4.0);
/// assert_eq!(4, vec.len());
/// assert_eq!(10, vec.capacity());
/// let vec = vec.to_complex_freq_vec();
/// assert_eq!(2, vec.points());
/// assert_eq!(4, vec.len());
/// assert_eq!(10, vec.alloc_len());
/// ```
fn to_complex_freq_vec(self) -> ComplexFreqVec<S, T>;
}
/// Retrieves the underlying storage from a vector. Returned value will always hold floating point numbers.
pub trait FromVectorFloat<T>
where
T: RealNumber,
{
/// Type of the underlying storage of a vector.
type Output;
/// Gets the underlying storage and the number of elements which
/// contain valid data. In case of complex vectors the values are returned real-imag pairs.
/// Refer to [`Into`](https://doc.rust-lang.org/std/convert/trait.Into.html) or [`FromVector`](trait.FromVector.html#)
/// for a method which returns the data of complex vectors in a different manner.
/// # Example
///
/// ```
/// # extern crate num_complex;
/// use basic_dsp_vector::*;
/// # use num_complex::Complex;
/// let v: Vec<Complex<f64>> = vec!(Complex::new(1.0, 2.0), Complex::new(3.0, 4.0));
/// let v: DspVec<Vec<f64>, f64, meta::Complex, meta::Time> = v.to_complex_time_vec();
/// // Note that the resulting type is always a vector or floats and not a vector of complex numbers
/// let (v, p): (Vec<f64>, usize) = v.getf();
/// assert_eq!(4, p);
/// assert_eq!(vec!(1.0, 2.0, 3.0, 4.0), v);
/// ```
fn getf(self) -> (Self::Output, usize);
}
/// Retrieves the underlying storage from a vector.
///
/// If you are working with `std::vec::Vec` then it's recommended to use
/// [`Into`](https://doc.rust-lang.org/std/convert/trait.Into.html#tymethod.into) instead of this one, as
/// it's more straightforward to use.
pub trait FromVector<T>
where
T: RealNumber,
{
/// Type of the underlying storage of a vector.
type Output;
/// If you are working with `std::vec::Vec` then it's recommended to use
/// [`Into`](https://doc.rust-lang.org/std/convert/trait.Into.html#tymethod.into) instead of this one, as
/// it's more straightforward to use.
///
/// Gets the underlying storage and the number of elements which
/// contain valid data. Therefore a caller should only use the first `valid data` elements from the storage.
/// The remaining elements (if there are any) might have been allocated during the calculations but contain
/// no useful information.
/// # Example
///
/// ```
/// # extern crate num_complex;
/// use basic_dsp_vector::*;
/// # use num_complex::Complex;
/// let v: Vec<Complex<f64>> = vec!(Complex::new(1.0, 2.0), Complex::new(3.0, 4.0));
/// let v: DspVec<Vec<f64>, f64, meta::Complex, meta::Time> = v.to_complex_time_vec();
/// let (v, p): (Vec<Complex<f64>>, usize) = v.get();
/// assert_eq!(2, p);
/// assert_eq!(vec!(Complex::new(1.0, 2.0), Complex::new(3.0, 4.0)), v);
/// ```
fn get(self) -> (Self::Output, usize);
}
impl<S, T, N, D> FromVectorFloat<T> for DspVec<S, T, N, D>
where
S: ToSlice<T>,
T: RealNumber,
N: NumberSpace,
D: Domain,
{
type Output = S;
fn getf(self) -> (Self::Output, usize) {
let len = self.valid_len;
(self.data, len)
}
}
impl<S, T, D> FromVector<T> for DspVec<S, T, meta::Real, D>
where
S: ToSlice<T>,
T: RealNumber,
D: Domain,
{
type Output = S;
fn get(self) -> (Self::Output, usize) {
let len = self.valid_len;
(self.data, len)
}
}
impl<S, T> From<S> for RealTimeVec<S, T>
where
S: ToSlice<T>,
T: RealNumber,
{
fn from(mut data: S) -> Self {
let len = data.len();
let alloc = data.alloc_len();
data.try_resize(alloc)
.expect("Expanding to alloc_len should always work");
RealTimeVec {
data,
delta: T::one(),
domain: meta::Time,
number_space: meta::Real,
valid_len: len,
multicore_settings: MultiCoreSettings::default(),
}
}
}
impl<S, T> From<S> for ComplexTimeVec<S, T>
where
S: ToSlice<T>,
T: RealNumber,
{
fn from(mut data: S) -> Self {
let len = data.len();
let alloc = data.alloc_len();
data.try_resize(alloc)
.expect("Expanding to alloc_len should always work");
ComplexTimeVec {
data,
delta: T::one(),
domain: meta::Time,
number_space: meta::Complex,
valid_len: len,
multicore_settings: MultiCoreSettings::default(),
}
}
}
impl<S, T> From<S> for RealFreqVec<S, T>
where
S: ToSlice<T>,
T: RealNumber,
{
fn from(mut data: S) -> Self {
let len = data.len();
let alloc = data.alloc_len();
data.try_resize(alloc)
.expect("Expanding to alloc_len should always work");
RealFreqVec {
data,
delta: T::one(),
domain: meta::Freq,
number_space: meta::Real,
valid_len: len,
multicore_settings: MultiCoreSettings::default(),
}
}
}
impl<S, T> From<S> for ComplexFreqVec<S, T>
where
S: ToSlice<T>,
T: RealNumber,
{
fn from(mut data: S) -> Self {
let len = data.len();
let alloc = data.alloc_len();
data.try_resize(alloc)
.expect("Expanding to alloc_len should always work");
ComplexFreqVec {
data,
delta: T::one(),
domain: meta::Freq,
number_space: meta::Complex,
valid_len: len,
multicore_settings: MultiCoreSettings::default(),
}
}
}
impl<S, T, N, D> Clone for DspVec<S, T, N, D>
where
S: ToSlice<T> + Clone,
T: RealNumber,
N: NumberSpace + Clone,
D: Domain + Clone,
{
fn clone(&self) -> Self {
DspVec {
data: self.data.clone(),
delta: self.delta,
domain: self.domain.clone(),
number_space: self.number_space.clone(),
valid_len: self.valid_len,
multicore_settings: self.multicore_settings,
}
}
fn clone_from(&mut self, source: &Self) {
self.data = source.data.clone();
self.delta = source.delta;
self.domain = source.domain.clone();
self.number_space = source.number_space.clone();
self.valid_len = source.valid_len;
self.multicore_settings = source.multicore_settings;
}
}