Struct grid_search_cardinal::Size

pub struct Size { /* fields omitted */ }

A size cannot be created which would contain un-addressable cells. That is, the maximum size has a width and height of one greater than the maximum i32.

Implementations

impl Size

pub fn try_new(
    width: u32,
    height: u32
) -> Result<Size, DimensionTooLargeForSize>

pub fn new(width: u32, height: u32) -> Size

Creates a new Size. Panics if width or width is greater than ::core::i32::MAX as u32 + 1.

pub const fn new_u16(width: u16, height: u16) -> Size

Like new, but const and never panics as it's impossible to construct an invalid size

pub fn from_coord(coord: Coord) -> Result<Size, NegativeDimension>

pub fn to_coord(self) -> Result<Coord, DimensionTooLargeForCoord>

pub fn get(self, axis: Axis) -> u32

pub fn get_mut(&mut self, axis: Axis) -> &mut u32

pub fn with_axis<F>(self, axis: Axis, f: F) -> Size where
    F: FnMut(u32) -> u32, 

pub fn try_set(
    self,
    axis: Axis,
    value: u32
) -> Result<Size, DimensionTooLargeForSize>

pub fn set(self, axis: Axis, value: u32) -> Size

pub fn try_set_in_place(
    &mut self,
    axis: Axis,
    value: u32
) -> Result<(), DimensionTooLargeForSize>

pub fn set_in_place(&mut self, axis: Axis, value: u32)

pub fn try_new_axis(
    this_axis: u32,
    other_axis: u32,
    axis: Axis
) -> Result<Size, DimensionTooLargeForSize>

pub fn new_axis(this_axis: u32, other_axis: u32, axis: Axis) -> Size

pub fn get_static<A>(self) -> u32 where
    A: StaticAxis, 

pub fn get_static_mut<A>(&mut self) -> &mut u32 where
    A: StaticAxis, 

pub fn with_static_axis<A, F>(self, f: F) -> Size where
    F: FnMut(u32) -> u32,
    A: StaticAxis, 

pub fn try_set_static<A>(
    self,
    value: u32
) -> Result<Size, DimensionTooLargeForSize> where
    A: StaticAxis, 

pub fn try_set_static_in_place<A>(
    &mut self,
    value: u32
) -> Result<(), DimensionTooLargeForSize> where
    A: StaticAxis, 

#[must_use]pub fn set_static<A>(self, value: u32) -> Size where
    A: StaticAxis, 

pub fn set_static_in_place<A>(&mut self, value: u32) where
    A: StaticAxis, 

pub fn try_new_static_axis<A>(
    this_axis: u32,
    other_axis: u32
) -> Result<Size, DimensionTooLargeForSize> where
    A: StaticAxis, 

pub fn new_static_axis<A>(this_axis: u32, other_axis: u32) -> Size where
    A: StaticAxis, 

pub fn try_set_width(self, width: u32) -> Result<Size, DimensionTooLargeForSize>

pub fn try_set_height(
    self,
    height: u32
) -> Result<Size, DimensionTooLargeForSize>

#[must_use]pub fn set_width(self, width: u32) -> Size

#[must_use]pub fn set_height(self, height: u32) -> Size

pub fn try_set_width_in_place(
    &mut self,
    width: u32
) -> Result<(), DimensionTooLargeForSize>

pub fn try_set_height_in_place(
    &mut self,
    height: u32
) -> Result<(), DimensionTooLargeForSize>

pub fn set_width_in_place(&mut self, width: u32)

pub fn set_height_in_place(&mut self, height: u32)

pub const fn width(self) -> u32

Returns the width.

pub const fn x(self) -> u32

Alias for width.

pub const fn height(self) -> u32

Returns the height.

pub const fn y(self) -> u32

Alias for height.

pub const fn count(self) -> usize

Return the number of cells in a 2D grid of this size.

pub fn checked_sub(self, rhs: Size) -> Option<Size>

pub fn saturating_sub(self, rhs: Size) -> Size

pub const fn max_field() -> u32

pub const fn max() -> Size

pub fn is_zero(self) -> bool

pub fn is_valid(self, coord: Coord) -> bool

pub fn constrain(self, coord: Coord) -> Option<Coord>

pub fn coord_iter_row_major(self) -> CoordIterRowMajor

pub fn pairwise_max(self, other: Size) -> Size

pub fn pairwise_min(self, other: Size) -> Size

Trait Implementations

impl<'a> Add<&'a Coord> for Size

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, &'a Coord) -> <Size as Add<&'a Coord>>::Output

Performs the + operation.

impl<'a, 'b> Add<&'a Coord> for &'b Size

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, &'a Coord) -> <&'b Size as Add<&'a Coord>>::Output

Performs the + operation.

impl<'a, 'b> Add<&'a Size> for &'b Coord

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, size: &'a Size) -> <&'b Coord as Add<&'a Size>>::Output

Performs the + operation.

impl<'a> Add<&'a Size> for Coord

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, size: &'a Size) -> <Coord as Add<&'a Size>>::Output

Performs the + operation.

impl<'a, 'b> Add<&'a Size> for &'b Size

type Output = Size

The resulting type after applying the + operator.

pub fn add(self, size: &'a Size) -> <&'b Size as Add<&'a Size>>::Output

Performs the + operation.

impl<'a> Add<&'a Size> for Size

type Output = Size

The resulting type after applying the + operator.

pub fn add(self, size: &'a Size) -> <Size as Add<&'a Size>>::Output

Performs the + operation.

impl Add<Coord> for Size

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, Coord) -> <Size as Add<Coord>>::Output

Performs the + operation.

impl<'a> Add<Coord> for &'a Size

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, Coord) -> <&'a Size as Add<Coord>>::Output

Performs the + operation.

impl<'a> Add<Size> for &'a Coord

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, size: Size) -> <&'a Coord as Add<Size>>::Output

Performs the + operation.

impl<'a> Add<Size> for &'a Size

type Output = Size

The resulting type after applying the + operator.

pub fn add(self, size: Size) -> <&'a Size as Add<Size>>::Output

Performs the + operation.

impl Add<Size> for Coord

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, size: Size) -> <Coord as Add<Size>>::Output

Performs the + operation.

impl Add<Size> for Size

type Output = Size

The resulting type after applying the + operator.

pub fn add(self, size: Size) -> <Size as Add<Size>>::Output

Performs the + operation.

impl Clone for Size

pub fn clone(&self) -> Size

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Size

impl Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

pub fn default() -> Size

Returns the "default value" for a type.

impl<'a> Div<u32> for &'a Size

type Output = Size

The resulting type after applying the / operator.

pub fn div(self, rhs: u32) -> <&'a Size as Div<u32>>::Output

Performs the / operation.

impl Div<u32> for Size

type Output = Size

The resulting type after applying the / operator.

pub fn div(self, rhs: u32) -> <Size as Div<u32>>::Output

Performs the / operation.

impl<T> DivAssign<T> for Size where
    Size: Div<T>,
    <Size as Div<T>>::Output == Size, 

pub fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl Eq for Size

impl From<[u32; 2]> for Size

pub fn from(array: [u32; 2]) -> Size

Performs the conversion.

impl From<(u32, u32)> for Size

pub fn from((u32, u32)) -> Size

Performs the conversion.

impl Hash for Size

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Mul<u32> for &'a Size

type Output = Size

The resulting type after applying the * operator.

pub fn mul(self, rhs: u32) -> <&'a Size as Mul<u32>>::Output

Performs the * operation.

impl Mul<u32> for Size

type Output = Size

The resulting type after applying the * operator.

pub fn mul(self, rhs: u32) -> <Size as Mul<u32>>::Output

Performs the * operation.

impl<T> MulAssign<T> for Size where
    Size: Mul<T>,
    <Size as Mul<T>>::Output == Size, 

pub fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Ord for Size

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Size> for Size

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Size> for Size

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

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

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

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for Size

impl StructuralPartialEq for Size

impl<'a, 'b> Sub<&'a Coord> for &'b Size

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, &'a Coord) -> <&'b Size as Sub<&'a Coord>>::Output

Performs the - operation.

impl<'a> Sub<&'a Coord> for Size

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, &'a Coord) -> <Size as Sub<&'a Coord>>::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a Size> for &'b Coord

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, size: &'a Size) -> <&'b Coord as Sub<&'a Size>>::Output

Performs the - operation.

impl<'a> Sub<&'a Size> for Coord

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, size: &'a Size) -> <Coord as Sub<&'a Size>>::Output

Performs the - operation.

impl<'a> Sub<&'a Size> for Size

type Output = Size

The resulting type after applying the - operator.

pub fn sub(self, size: &'a Size) -> <Size as Sub<&'a Size>>::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a Size> for &'b Size

type Output = Size

The resulting type after applying the - operator.

pub fn sub(self, size: &'a Size) -> <&'b Size as Sub<&'a Size>>::Output

Performs the - operation.

impl<'a> Sub<Coord> for &'a Size

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, Coord) -> <&'a Size as Sub<Coord>>::Output

Performs the - operation.

impl Sub<Coord> for Size

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, Coord) -> <Size as Sub<Coord>>::Output

Performs the - operation.

impl<'a> Sub<Size> for &'a Coord

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, size: Size) -> <&'a Coord as Sub<Size>>::Output

Performs the - operation.

impl Sub<Size> for Size

type Output = Size

The resulting type after applying the - operator.

pub fn sub(self, size: Size) -> <Size as Sub<Size>>::Output

Performs the - operation.

impl<'a> Sub<Size> for &'a Size

type Output = Size

The resulting type after applying the - operator.

pub fn sub(self, size: Size) -> <&'a Size as Sub<Size>>::Output

Performs the - operation.

impl Sub<Size> for Coord

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, size: Size) -> <Coord as Sub<Size>>::Output

Performs the - operation.