Struct ShortlexIntegerVector 

pub struct ShortlexIntegerVector(pub IntegerVector);

ShortlexIntegerVector is a wrapper around an IntegerVector, taking the IntegerVector by value.

IntegerVector does not implement Ord, because no order on vectors is canonical: lex, graded lex, and the others all have their uses, and the order most natural mathematically, comparing vectors of the same dimension element by element, is only partial. Wrapping a IntegerVector in an ShortlexIntegerVector provides one total order: vectors are compared first by dimension and then, in case of a tie, lexicographically, by their elements from first to last. Its equality agrees with IntegerVector equality.

Unlike lexicographic order on Vecs, this order puts every vector of a smaller dimension before every vector of a larger one, so that $(5) < (0, 0)$. It is not a well-order, since the Integers are not: $(0) > (-1) > (-2) > \ldots$ descends forever.

ShortlexIntegerVector owns its value. This is useful in many cases, for example if you want to use IntegerVectors as keys in a BTreeMap. In other situations, it is better to use ShortlexIntegerVectorRef, which only has a reference to its value.

Tuple Fields

0: IntegerVector

Implementations

impl ShortlexIntegerVector

pub const fn as_ref(&self) -> ShortlexIntegerVectorRef<'_>

Borrows an ShortlexIntegerVector as a ShortlexIntegerVectorRef.

Worst-case complexity

Constant time and additional memory.

Examples

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

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

Trait Implementations

impl Clone for ShortlexIntegerVector

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 ShortlexIntegerVector

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

Formats the value using the given formatter.

impl Deref for ShortlexIntegerVector

fn deref(&self) -> &IntegerVector

Allows an ShortlexIntegerVector to dereference to an IntegerVector.

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

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

type Target = IntegerVector

The resulting type after dereferencing.

impl Eq for ShortlexIntegerVector

impl Hash for ShortlexIntegerVector

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 ShortlexIntegerVector

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

Compares two ShortlexIntegerVectors.

The order is shortlex: the vectors are compared first by dimension, and then, in case of a tie, lexicographically. See the Ord implementation for ShortlexIntegerVectorRef for details.

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, ShortlexIntegerVector};
use std::collections::BTreeSet;

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

// Dimension decides, whatever the elements.
assert!(ShortlexIntegerVector(five.clone()) < ShortlexIntegerVector(zero_zero.clone()));

// The wrapper makes vectors usable in ordered collections.
let set: BTreeSet<_> = [zero_zero, five]
    .into_iter()
    .map(ShortlexIntegerVector)
    .collect();
assert_eq!(
    set.iter().map(|v| v.to_string()).collect::<Vec<_>>(),
    ["(5)", "(0, 0)"]
);

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 PartialEq for ShortlexIntegerVector

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ShortlexIntegerVector

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

Compares two ShortlexIntegerVectors.

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 StructuralPartialEq for ShortlexIntegerVector