Struct Grid 

pub struct Grid { /* private fields */ }

A grid of conditions (see the module documentation).

Implementations

impl Grid

pub fn new() -> Grid

An empty grid (one empty condition).

pub fn from_conditions(conditions: Vec<Condition>) -> Grid

An explicit list of conditions.

pub fn axis<V: Into<Value>>( self, name: &str, values: impl IntoIterator<Item = V>, ) -> Grid

Add an axis of values.

pub fn zip(self, names: &[&str], rows: Vec<Vec<Value>>) -> Result<Grid>

Add axes that vary together: rows[i] gives one value per name.

Errors

Error::Shape if a row does not have one value per name.

Examples

use comnum_sim::grid::Grid;
let g = Grid::new().zip(&["m", "kind"], vec![vec![4usize.into(), "qam".into()], vec![8usize.into(), "psk".into()]])?;
assert_eq!(g.conditions()[1].label(), "m=8, kind=psk");
assert!(Grid::new().zip(&["m", "kind"], vec![vec![4usize.into()]]).is_err());

pub fn fixed(self, name: &str, value: impl Into<Value>) -> Grid

Add a constant to every condition.

pub fn check(&self) -> Result<()>

Check that every key is given once: by one axis, zip or fixed value, and not by one of them on top of an explicit condition.

Errors

Error::Config naming the first key given twice.

Examples

use comnum_sim::grid::{Condition, Grid};
assert!(Grid::new().axis("snr_db", [0.0, 1.0]).fixed("m", 4usize).check().is_ok());
let e = Grid::new().axis("snr_db", [0.0]).axis("snr_db", [1.0]).check().unwrap_err();
assert!(e.to_string().contains("\"snr_db\" twice"));
let cases = Grid::from_conditions(vec![Condition::new().with("m", 4usize)]);
assert!(cases.axis("m", [16usize]).check().is_err());

pub fn conditions(&self) -> Vec<Condition>

The conditions, in order.

pub fn len(&self) -> usize

Number of conditions.

pub fn is_empty(&self) -> bool

Whether the grid has no condition.

Trait Implementations

impl Clone for Grid

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 Grid

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

Formats the value using the given formatter.

impl Default for Grid

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Grid

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Grid