Struct GridSamplerCluster

pub struct GridSamplerCluster {
    pub from: (usize, usize),
    pub to: (usize, usize),
}

Grid sampler that sum fields contained by cluster bounds.

Note

Weight component of sampling result equals number of sampled fields.

Example

use psyche_utils::grid::{Grid, GridSamplerCluster};

let grid = Grid::new(2, 2, 1.0);
let sampler = GridSamplerCluster::new((0, 0), (1, 1));
assert_eq!(grid.sample(sampler).unwrap(), (4.0, 4));

Fields

from: (usize, usize)

Bounds column and row starting point.

to: (usize, usize)

Bounds number of columns and rows that defines cluster size.

Implementations

impl GridSamplerCluster

pub fn new(from: (usize, usize), to: (usize, usize)) -> Self

pub fn center(center: (usize, usize), size: (usize, usize)) -> Self

pub fn center_extents(center: (usize, usize), extents: (usize, usize)) -> Self

pub fn valid_from(&self) -> (usize, usize)

pub fn valid_to(&self) -> (usize, usize)

pub fn cells(&self) -> usize

Trait Implementations

impl Clone for GridSamplerCluster

fn clone(&self) -> GridSamplerCluster

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridSamplerCluster

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

Formats the value using the given formatter.

impl<T> GridSampler<T, usize> for GridSamplerCluster

where T: GridSampleZeroValue<T> + Add<Output = T> + Clone,

fn sample(self, grid: &Grid<T>) -> Option<(T, usize)>

Sample value and weight from given grid.

impl PartialEq for GridSamplerCluster

fn eq(&self, other: &GridSamplerCluster) -> 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 Eq for GridSamplerCluster

impl StructuralPartialEq for GridSamplerCluster