Struct ShortlexIntegerVectorRef 

pub struct ShortlexIntegerVectorRef<'a>(pub &'a IntegerVector);

ShortlexIntegerVectorRef is a wrapper around an IntegerVector, taking the IntegerVector by reference.

See the ShortlexIntegerVector documentation for details.

Tuple Fields

0: &'a IntegerVector

Trait Implementations

impl<'a> Clone for ShortlexIntegerVectorRef<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ShortlexIntegerVectorRef<'a>

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

Formats the value using the given formatter.

impl Deref for ShortlexIntegerVectorRef<'_>

fn deref(&self) -> &IntegerVector

Allows a ShortlexIntegerVectorRef to dereference to an IntegerVector.

use core::str::FromStr;
use malachite_nz::integer_vector::{IntegerVector, ShortlexIntegerVectorRef};

let v = IntegerVector::from_str("(1, 2, 3)").unwrap();
let x = ShortlexIntegerVectorRef(&v);
assert_eq!(*x, v);

type Target = IntegerVector

The resulting type after dereferencing.

impl<'a> Eq for ShortlexIntegerVectorRef<'a>

impl<'a> Hash for ShortlexIntegerVectorRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ShortlexIntegerVectorRef<'_>

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

Compares two ShortlexIntegerVectorRefs.

The order is shortlex: the vectors are compared first by dimension, and then, in case of a tie, lexicographically, by their elements from first to last. The 0-dimensional vector comes first. This is a total order, and its equality agrees with IntegerVector equality.

Where the dimensions differ this parts company with the lexicographic order of Vecs: here dimension decides outright, so $(5) < (0, 0)$, where lexicographic order has $(5) > (0, 0)$.

Worst-case complexity

$T(n) = O(n)$

$M(n) = O(1)$

where $T$ is time, $M$ is additional memory, and $n$ is the smaller of the two vectors’ total number of bits, summed over their elements. Vectors of different dimensions are compared in constant time.

Examples

use core::str::FromStr;
use malachite_nz::integer_vector::{IntegerVector, ShortlexIntegerVectorRef};

let empty = IntegerVector::from_str("()").unwrap();
let five = IntegerVector::from_str("(5)").unwrap();
let zero_zero = IntegerVector::from_str("(0, 0)").unwrap();
let zero_one = IntegerVector::from_str("(0, 1)").unwrap();

// The 0-dimensional vector comes first.
assert!(ShortlexIntegerVectorRef(&empty) < ShortlexIntegerVectorRef(&five));
// Dimension decides, whatever the elements.
assert!(ShortlexIntegerVectorRef(&five) < ShortlexIntegerVectorRef(&zero_zero));
// At equal dimensions, the first differing element decides.
assert!(ShortlexIntegerVectorRef(&zero_zero) < ShortlexIntegerVectorRef(&zero_one));

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl<'a> PartialEq for ShortlexIntegerVectorRef<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ShortlexIntegerVectorRef<'_>

fn partial_cmp(&self, other: &ShortlexIntegerVectorRef<'_>) -> Option<Ordering>

Compares two ShortlexIntegerVectorRefs.

See the documentation for the Ord implementation.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> StructuralPartialEq for ShortlexIntegerVectorRef<'a>