Struct RTS 

pub struct RTS {
    pub trellis: Trellis,
}

Fields

trellis: Trellis

Implementations

impl RTS

pub fn new(num_bits: usize, n_max: usize, weights: &[usize]) -> RTS

Returns an RTS instance which encodes at least num_bits bits

The smallest possible trellis that encodes num_bits bits is used, in some cases this trellis is capable of encoding more than num_bits bits.

impl RTS

pub fn num_sequences(&self) -> Integer

Returns the number of sequences that can be encoded / decoded

pub fn num_bits(&self) -> u32

Returns the number of bits that can be encoded / decoded

pub fn get_weights(&self) -> Vec<usize>

Returns the weights used by the internal trellis

pub fn get_distribution(&self, res_factor: f32) -> Vec<f32>

Returns the distribution RTS is optimizing for

pub fn sequence_for_index(&self, index: &Integer) -> Vec<usize>

Returns the amplitude sequence for a given index

pub fn index_for_sequence(&self, amplitude_sequence: &[usize]) -> Integer

Returns the index for a given amplitude sequence

pub fn amplitude_distribution(&self) -> Vec<f32>

Returns the amplitude distribution as a Vec

The amplitude distribution is valid if only sequences with indexes representable with [self.num_bits] bits are used.

pub fn amplitude_distribution_full_utilization(&self) -> Vec<f32>

Returns the amplitude distribution as a Vec

The amplitude distribution is valid if all sequences in the trellis are used equiprobably.