Struct Point

pub struct Point { /* private fields */ }

Point represents a specific coordinate within the multi-dimensional space defined by an Extent.

Coordinate values can be accessed by indexing:

use ndslice::extent;

let ext = extent!(zone = 2, host = 4, gpu = 8);
let point = ext.point(vec![1, 2, 3]).unwrap();
assert_eq!(point[0], 1);
assert_eq!(point[1], 2);
assert_eq!(point[2], 3);

Implementations

impl Point

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

Returns a reference to the coordinate vector for this point.

pub fn extent(&self) -> &Extent

Returns a reference to the extent associated with this point.

pub fn rank(&self) -> usize

Computes the row-major logical rank of this point within its extent.

Σ (coord[i] × ∏(sizes[j] for j > i))

where coord is the point’s coordinate and sizes is the extent’s dimension sizes.

pub fn len(&self) -> usize

The dimensionality of this point.

pub fn is_empty(&self) -> bool

Is this the 0d constant []?

Trait Implementations

impl Clone for Point

fn clone(&self) -> Point

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Point

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Point

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

Formats the value using the given formatter.

impl Hash for Point

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 Index<usize> for Point

fn index(&self, dim: usize) -> &Self::Output

Returns the coordinate value for the given dimension index. This allows using point[0] syntax instead of point.coords()[0].

type Output = usize

The returned type after indexing.

impl<'a> IntoIterator for &'a Point

fn into_iter(self) -> Self::IntoIter

Iterates over the coordinate values of this point.

This allows using for coord in &point { ... } syntax to iterate through each dimension’s coordinate value.

type Item = usize

The type of the elements being iterated over.

type IntoIter = Cloned<Iter<'a, usize>>

Which kind of iterator are we turning this into?

impl PartialEq for Point

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Point

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Point

impl StructuralPartialEq for Point