Struct visioncortex::Field

pub struct Field<T> { /* private fields */ }

Vec<T> that represents a 2D field

Implementations

impl<T> Field<T>

The base implementation of Field

pub fn with_vec(width: usize, height: usize, data: Vec<T>) -> Option<Self>

Constructs a height by width field with data. Returns None if the size of data does not equal to height * width.

pub fn width(&self) -> usize

Returns the width of the field.

pub fn height(&self) -> usize

Returns the height of the field.

pub fn peek(&self, index: usize) -> Option<&T>

Returns a reference to an element.

pub fn peek_mut(&mut self, index: usize) -> Option<&mut T>

Returns a mutable reference to an element.

pub fn replace(&mut self, index: usize, value: T) -> Option<T>

Replaces an element with value and returns the element.

pub fn locate(&self, index: usize) -> (usize, usize)

Returns the xy-coordinates representation of an index in the field.

pub fn index_at(&self, x: usize, y: usize) -> usize

Returns the index of a xy-coordinates representation in the field.

pub fn iter(&self) -> impl Iterator + '_

pub fn iter_mut(&mut self) -> impl Iterator + '_

impl<T> Field<T>

where T: Default,

pub fn with_default(width: usize, height: usize) -> Self

Constructs a height by width field, with each slot filled with the default value of its element type.

impl<T> Field<T>

where T: Clone,

pub fn with_initial(width: usize, height: usize, value: T) -> Self

Constructs a height by width field, with each slot filled with value.

pub fn get(&self, index: usize) -> Option<T>

Returns a copy of an element.

pub fn set(&mut self, index: usize, value: &T)

Assigns a copy of a value to a slot.

Trait Implementations

impl<T: Clone> Clone for Field<T>

fn clone(&self) -> Field<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for Field<T>

fn default() -> Field<T>

Returns the “default value” for a type.

impl<T> IntoIterator for Field<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<Field<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.