Skip to main content

Labels

Struct Labels 

Source
pub struct Labels(/* private fields */);
Expand description

The labels of symbols, one row per stream: the index $a \in \{0, \dots, M - 1\}$ of every symbol of an alphabet of $M$ (a chirp of chirp spread spectrum, a level of continuous-phase modulation, a point of a constellation), the input and the decisions of the waveforms that carry an index (Modulate<Labels>).

Implementations§

Source§

impl Labels

Source

pub fn new(data: Array2<usize>) -> Labels

A container from a [n_streams, n] array.

Source

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

n_streams streams of n zeros.

Source

pub fn from_stream(v: Vec<usize>) -> Result<Labels>

One stream.

§Errors

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

Source

pub fn from_streams(streams: &[Vec<usize>]) -> Result<Labels>

Several streams of equal length.

§Errors

Error::Shape if the streams have different lengths.

Source

pub fn n_streams(&self) -> usize

Number of streams.

Source

pub fn len(&self) -> usize

Number of elements per stream.

Source

pub fn is_empty(&self) -> bool

Whether the streams are empty.

Source

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

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

Source

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

Stream i as an ndarray view.

Source

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

Stream i as a mutable ndarray view.

Source

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

All the elements, stream after stream.

Source

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

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

Source

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

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

Source

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

Stream i as a mutable slice.

Source

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

All the elements, stream after stream, mutable.

Source

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

The underlying [n_streams, n] array.

Source

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

The underlying array, mutable.

Source

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§

Source§

impl Clone for Labels

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Labels

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Labels

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Labels

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Labels

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.