Struct dasp::sample::types::I48

pub struct I48(_);

Implementations

impl I48

pub fn new(val: i64) -> Option<I48>

Construct a new sample if the given value is within range.

Returns None if val is out of range.

pub fn new_unchecked(s: i64) -> I48

Constructs a new sample without checking for overflowing.

This should only be used if the user can guarantee the sample will be within range and they require the extra performance.

If this function is used, the sample crate can't guarantee that the returned sample or any interacting samples will remain within their MIN and MAX bounds.

pub fn inner(self) -> i64

Return the internal value used to represent the sample type.

Trait Implementations

impl Add<I48> for I48

type Output = I48

The resulting type after applying the + operator.

fn add(self, other: I48) -> I48

Performs the + operation.

impl BitAnd<I48> for I48

type Output = I48

The resulting type after applying the & operator.

fn bitand(self, other: I48) -> I48

Performs the & operation.

impl BitOr<I48> for I48

type Output = I48

The resulting type after applying the | operator.

fn bitor(self, other: I48) -> I48

Performs the | operation.

impl BitXor<I48> for I48

type Output = I48

The resulting type after applying the ^ operator.

fn bitxor(self, other: I48) -> I48

Performs the ^ operation.

impl Clone for I48

fn clone(&self) -> I48

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for I48

impl Debug for I48

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

Formats the value using the given formatter.

impl Default for I48

fn default() -> I48

Returns the "default value" for a type.

impl Div<I48> for I48

type Output = I48

The resulting type after applying the / operator.

fn div(self, other: I48) -> I48

Performs the / operation.

impl Eq for I48

impl Frame for I48

type Sample = I48

The type of PCM sample stored at each channel within the frame.

type NumChannels = N1

A typified version of a number of channels in the Frame, used for safely mapping frames of the same length to other Frames, perhaps with a different Sample associated type.

type Channels = Channels<I48>

An iterator yielding the sample in each channel, starting from left (channel 0) and ending at the right (channel NumChannels-1).

type Float = <I48 as Sample>::Float

A frame type with equilavent number of channels using the associated Sample::Float format.

type Signed = <I48 as Sample>::Signed

A frame type with equilavent number of channels using the associated Sample::Signed format.

const EQUILIBRIUM: I48

The equilibrium value for the wave that this Sample type represents. This is normally the value that is equal distance from both the min and max ranges of the sample.

const CHANNELS: usize

The total number of channels within the frame.

fn channels(self) -> <I48 as Frame>::Channels

Converts the frame into an iterator yielding the sample for each channel in the frame.

fn channel(&self, idx: usize) -> Option<&<I48 as Frame>::Sample>

Yields a reference to the Sample of the channel at the given index if there is one.

fn from_fn<F>(from: F) -> I48 where
    F: FnMut(usize) -> <I48 as Frame>::Sample, 

Create a new Frame where the Sample for each channel is produced by the given function.

fn from_samples<I>(samples: &mut I) -> Option<I48> where
    I: Iterator<Item = <I48 as Frame>::Sample>, 

Create a new Frame from a borrowed Iterator yielding samples for each channel.

unsafe fn channel_unchecked(&self, _idx: usize) -> &<I48 as Frame>::Sample

Returns a pointer to the sample of the channel at the given index, without doing bounds checking.

fn to_signed_frame(self) -> <I48 as Frame>::Signed

Converts the frame type to the equivalent signal in its associated Floating point format.

fn to_float_frame(self) -> <I48 as Frame>::Float

Converts the frame type to the equivalent signal in its associated Signed format.

fn map<F, M>(self, map: M) -> F where
    F: Frame<NumChannels = <I48 as Frame>::NumChannels>,
    M: FnMut(<I48 as Frame>::Sample) -> <F as Frame>::Sample, 

Applies the given function to each sample in the Frame in channel order and returns the result as a new Frame.

fn zip_map<O, F, M>(self, other: O, zip_map: M) -> F where
    F: Frame<NumChannels = <I48 as Frame>::NumChannels>,
    M: FnMut(<I48 as Frame>::Sample, <O as Frame>::Sample) -> <F as Frame>::Sample,
    O: Frame<NumChannels = <I48 as Frame>::NumChannels>, 

Calls the given function with the pair of elements at every index and returns the resulting Frame.

fn scale_amp(self, amp: <I48 as Sample>::Float) -> I48

Multiplies each Sample in the Frame by the given amplitude and returns the resulting Frame.

fn add_amp<F>(self, other: F) -> I48 where
    F: Frame<Sample = <I48 as Sample>::Signed, NumChannels = N1>, 

Sums each channel in other with each channel in self and returns the resulting Frame.

fn offset_amp(self, offset: <Self::Sample as Sample>::Signed) -> Self

Offsets the amplitude of every channel in the frame by the given offset and yields the resulting frame.

fn mul_amp<F>(self, other: F) -> Self where
    F: Frame<Sample = <Self::Sample as Sample>::Float, NumChannels = Self::NumChannels>, 

Multiplies other with self and returns the resulting Frame.

impl From<I20> for I48

fn from(other: I20) -> I48

Performs the conversion.

impl From<I24> for I48

fn from(other: I24) -> I48

Performs the conversion.

impl From<U20> for I48

fn from(other: U20) -> I48

Performs the conversion.

impl From<U24> for I48

fn from(other: U24) -> I48

Performs the conversion.

impl From<i16> for I48

fn from(other: i16) -> I48

Performs the conversion.

impl From<i32> for I48

fn from(other: i32) -> I48

Performs the conversion.

impl From<i64> for I48

fn from(val: i64) -> I48

Performs the conversion.

impl From<i8> for I48

fn from(other: i8) -> I48

Performs the conversion.

impl From<u16> for I48

fn from(other: u16) -> I48

Performs the conversion.

impl From<u32> for I48

fn from(other: u32) -> I48

Performs the conversion.

impl From<u8> for I48

fn from(other: u8) -> I48

Performs the conversion.

impl FromSample<I24> for I48

fn from_sample_(s: I24) -> I48

impl FromSample<I48> for f32

fn from_sample_(s: I48) -> f32

impl FromSample<I48> for u64

fn from_sample_(s: I48) -> u64

impl FromSample<I48> for U48

fn from_sample_(s: I48) -> U48

impl FromSample<I48> for u16

fn from_sample_(s: I48) -> u16

impl FromSample<I48> for i16

fn from_sample_(s: I48) -> i16

impl FromSample<I48> for U24

fn from_sample_(s: I48) -> U24

impl FromSample<I48> for i8

fn from_sample_(s: I48) -> i8

impl FromSample<I48> for i32

fn from_sample_(s: I48) -> i32

impl FromSample<I48> for i64

fn from_sample_(s: I48) -> i64

impl FromSample<I48> for I24

fn from_sample_(s: I48) -> I24

impl FromSample<I48> for f64

fn from_sample_(s: I48) -> f64

impl FromSample<I48> for u32

fn from_sample_(s: I48) -> u32

impl FromSample<I48> for u8

fn from_sample_(s: I48) -> u8

impl FromSample<U24> for I48

fn from_sample_(s: U24) -> I48

impl FromSample<U48> for I48

fn from_sample_(s: U48) -> I48

impl FromSample<f32> for I48

fn from_sample_(s: f32) -> I48

impl FromSample<f64> for I48

fn from_sample_(s: f64) -> I48

impl FromSample<i16> for I48

fn from_sample_(s: i16) -> I48

impl FromSample<i32> for I48

fn from_sample_(s: i32) -> I48

impl FromSample<i64> for I48

fn from_sample_(s: i64) -> I48

impl FromSample<i8> for I48

fn from_sample_(s: i8) -> I48

impl FromSample<u16> for I48

fn from_sample_(s: u16) -> I48

impl FromSample<u32> for I48

fn from_sample_(s: u32) -> I48

impl FromSample<u64> for I48

fn from_sample_(s: u64) -> I48

impl FromSample<u8> for I48

fn from_sample_(s: u8) -> I48

impl Mul<I48> for I48

type Output = I48

The resulting type after applying the * operator.

fn mul(self, other: I48) -> I48

Performs the * operation.

impl Neg for I48

type Output = I48

The resulting type after applying the - operator.

fn neg(self) -> I48

Performs the unary - operation.

impl Not for I48

type Output = I48

The resulting type after applying the ! operator.

fn not(self) -> I48

Performs the unary ! operation.

impl Ord for I48

fn cmp(&self, other: &I48) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<I48> for I48

fn eq(&self, other: &I48) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &I48) -> bool

This method tests for !=.

impl PartialOrd<I48> for I48

fn partial_cmp(&self, other: &I48) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &I48) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &I48) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &I48) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &I48) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<I48> for I48

type Output = I48

The resulting type after applying the % operator.

fn rem(self, other: I48) -> I48

Performs the % operation.

impl Sample for I48

type Signed = I48

When summing two samples of a signal together, it is necessary for both samples to be represented in some signed format. This associated Addition type represents the format to which Self should be converted for optimal Addition performance.

type Float = f64

When multiplying two samples of a signal together, it is necessary for both samples to be represented in some signed, floating-point format. This associated Multiplication type represents the format to which Self should be converted for optimal Multiplication performance.

const EQUILIBRIUM: I48

The equilibrium value for the wave that this Sample type represents. This is normally the value that is equal distance from both the min and max ranges of the sample.

const IDENTITY: Self::Float

The multiplicative identity of the signal.

fn to_sample<S>(self) -> S where
    Self: ToSample<S>, 

Convert self to any type that implements FromSample<Self>.

fn from_sample<S>(s: S) -> Self where
    Self: FromSample<S>, 

Create a Self from any type that implements ToSample<Self>.

fn to_signed_sample(self) -> Self::Signed

Converts self to the equivalent Sample in the associated Signed format.

fn to_float_sample(self) -> Self::Float

Converts self to the equivalent Sample in the associated Float format.

fn add_amp(self, amp: Self::Signed) -> Self

Adds (or "offsets") the amplitude of the Sample by the given signed amplitude.

fn mul_amp(self, amp: Self::Float) -> Self

Multiplies (or "scales") the amplitude of the Sample by the given float amplitude.

impl Shl<I48> for I48

type Output = I48

The resulting type after applying the << operator.

fn shl(self, other: I48) -> I48

Performs the << operation.

impl Shr<I48> for I48

type Output = I48

The resulting type after applying the >> operator.

fn shr(self, other: I48) -> I48

Performs the >> operation.

impl SignedSample for I48

impl StructuralEq for I48

impl StructuralPartialEq for I48

impl Sub<I48> for I48

type Output = I48

The resulting type after applying the - operator.

fn sub(self, other: I48) -> I48

Performs the - operation.