Struct tydi::physical::Complexity

pub struct Complexity { /* fields omitted */ }

Interface complexity level.

This logical stream parameter specifies the guarantees a source makes about how elements are transferred. Equivalently, it specifies the assumptions a sink can safely make.

Examples

use tydi::physical::Complexity;

let c3 = Complexity::new_major(3);
let c30 = Complexity::new(vec![3, 0])?;
let c31 = Complexity::new(vec![3, 1])?;
let c4 = Complexity::new_major(4);

assert_eq!(c3, c30);
assert!(c3 < c31);
assert!(c31 < c4);

assert_eq!(c31.to_string(), "3.1");

Reference

Methods

impl Complexity

pub fn new(level: impl IntoIterator<Item = NonNegative>) -> Result<Self>

Constructs a new Complexity with provided level. Returns an error when the provided level iterator is empty.

Examples

use tydi::physical::Complexity;

let c = Complexity::new(vec![1, 2, 3, 4])?;
assert!(Complexity::new(vec![]).is_err());

pub fn new_major(level: NonNegative) -> Self

Constructs a new Complexity with provided level as major version.

Examples

use tydi::physical::Complexity;

let c = Complexity::new_major(4);

assert_eq!(c, Complexity::new(vec![4])?);

pub fn level(&self) -> &[NonNegative]

Returns the level of this Complexity.

Examples

use tydi::physical::Complexity;

let c = Complexity::new(vec![3, 14])?;
assert_eq!(c.level(), &[3, 14]);

pub fn major(&self) -> NonNegative

Returns the major version of this Complexity level.

Examples

use tydi::physical::Complexity;

let c = Complexity::new(vec![3, 14])?;
assert_eq!(c.major(), 3);

Trait Implementations

impl Clone for Complexity

fn clone(&self) -> Complexity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Complexity

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

Formats the value using the given formatter.

impl Default for Complexity

fn default() -> Self

Returns the "default value" for a type.

impl Display for Complexity

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

Display a complexity level as a version number. The levels are separated by periods.

Examples

use tydi::physical::Complexity;

let c = Complexity::new(vec![3, 14])?;
assert_eq!(c.to_string(), "3.14");

impl Eq for Complexity

impl From<u32> for Complexity

fn from(major: NonNegative) -> Self

Convert a NonNegative into complexity with the NonNegative as major version.

impl FromStr for Complexity

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Ord for Complexity

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

A complexity number is higher than another when the leftmost integer is greater, and lower when the leftmost integer is lower. If the leftmost integer is equal, the next integer is checked recursively. If one complexity number has more entries than another, the shorter number is padded with zeros on the right.

#[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<Complexity> for Complexity

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

A complexity number is higher than another when the leftmost integer is greater, and lower when the leftmost integer is lower. If the leftmost integer is equal, the next integer is checked recursively. If one complexity number has more entries than another, the shorter number is padded with zeros on the right.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Complexity> for Complexity

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl TryFrom<Vec<u32>> for Complexity

type Error = Error

The type returned in the event of a conversion error.

fn try_from(level: Vec<NonNegative>) -> Result<Self>

Try to convert a vector of NonNegative into a complexity. Returns an error when the provided vector is empty.