Struct Symbols 

pub struct Symbols(/* private fields */);

Complex symbols at one sample per symbol, one row per stream.

Implementations

impl Symbols

pub fn new(data: Array2<C64>) -> Symbols

A container from a [n_streams, n] array.

pub fn zeros(n_streams: usize, n: usize) -> Symbols

n_streams streams of n zeros.

pub fn from_stream(v: Vec<C64>) -> Result<Symbols>

One stream.

Errors

Never in practice; the signature matches Self::from_streams.

pub fn from_streams(streams: &[Vec<C64>]) -> Result<Symbols>

Several streams of equal length.

Errors

Error::Shape if the streams have different lengths.

pub fn n_streams(&self) -> usize

Number of streams.

pub fn len(&self) -> usize

Number of elements per stream.

pub fn is_empty(&self) -> bool

Whether the streams are empty.

pub fn stream(&self, i: usize) -> &[C64]

Stream i as a slice (the layout is always standard).

pub fn stream_view(&self, i: usize) -> ArrayView1<'_, C64>

Stream i as an ndarray view.

pub fn stream_view_mut(&mut self, i: usize) -> ArrayViewMut1<'_, C64>

Stream i as a mutable ndarray view.

pub fn as_slice(&self) -> &[C64]

All the elements, stream after stream.

pub fn set_stream(&mut self, x: &[C64])

Make self the single stream x, reusing its storage when the length is unchanged (ADR 0011).

pub fn assign(&mut self, a: &Array2<C64>)

Make self a copy of a, reusing its storage when the shape is unchanged (ADR 0011).

pub fn stream_mut(&mut self, i: usize) -> &mut [C64]

Stream i as a mutable slice.

pub fn as_slice_mut(&mut self) -> &mut [C64]

All the elements, stream after stream, mutable.

pub fn as_array(&self) -> &Array2<C64>

The underlying [n_streams, n] array.

pub fn as_array_mut(&mut self) -> &mut Array2<C64>

The underlying array, mutable.

pub fn resize(&mut self, n_streams: usize, n: usize)

Resize to n_streams × n (the content is reset when the shape changes), so that an _into method can reuse a caller-owned buffer.

Trait Implementations

impl Clone for Symbols

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbols

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

Formats the value using the given formatter.

impl Default for Symbols

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Symbols

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Symbols