Struct CMapBuilder

pub struct CMapBuilder<T>
where
    T: CoordsFloat,
{ /* private fields */ }

Combinatorial map builder structure

Example

use honeycomb_core::prelude::{CMap2, CMapBuilder};

let builder = CMapBuilder::default().n_darts(10);
let map: CMap2<f64> = builder.build()?;

assert_eq!(map.n_darts(), 11); // 10 + null dart = 11

Implementations

impl<T: CoordsFloat> CMapBuilder<T>

Regular methods

pub fn n_darts(self, n_darts: usize) -> Self

Set the number of dart that the created map will contain.

pub fn grid_descriptor(self, grid_descriptor: GridDescriptor<T>) -> Self

Set the GridDescriptor that will be used when building the map.

pub fn vtk_file(self, file_path: impl AsRef<Path> + Debug) -> Self

Set the VTK file that will be used when building the map.

Panics

This function may panic if the file cannot be loaded.

pub fn add_attribute<A: AttributeBind + 'static>(self) -> Self

Add the attribute A to the attributes the created map will contain.

Usage

Each attribute must be uniquely typed, i.e. a single type or struct cannot be added twice to the builder / map. This includes type aliases as these are not distinct from the compiler’s perspective.

If you have multiple attributes that are represented using the same data type, you may want to look into the Newtype pattern here and here

pub fn build(self) -> Result<CMap2<T>, BuilderError>

Consumes the builder and produce a CMap2 object.

Return / Errors

This method return a Result taking the following values:

• Ok(map: CMap2) if generation was successful,
• Err(BuilderError) otherwise. See BuilderError for possible failures.

Panics

This method may panic if type casting goes wrong during parameters parsing.

impl<T: CoordsFloat> CMapBuilder<T>

Pre-definite structures

pub fn unit_grid(n_square: usize) -> Self

Create a CMapBuilder with a predefinite GridDescriptor value.

Arguments

• n_square: usize – Number of cells along each axis.

Return

This function return a builder structure with pre-definite parameters set to generate a specific map.

The map generated by this pre-definite value corresponds to an orthogonal mesh, with an equal number of cells along each axis:

pub fn unit_triangles(n_square: usize) -> Self

Create a CMapBuilder with a predefinite GridDescriptor value.

Arguments

• n_square: usize – Number of cells along each axis.

Return

This function return a builder structure with pre-definite parameters set to generate a specific map.

The map generated by this pre-definite value corresponds to an orthogonal mesh, with an equal number of cells along each axis. Each cell will be split across their diagonal (top left to bottom right) to form triangles:

Trait Implementations

impl<T> Default for CMapBuilder<T>

where T: CoordsFloat + Default,

fn default() -> CMapBuilder<T>

Returns the “default value” for a type.

impl<T: CoordsFloat> From<GridDescriptor<T>> for CMapBuilder<T>

fn from(value: GridDescriptor<T>) -> Self

Converts to this type from the input type.

impl<T: CoordsFloat, P: AsRef<Path> + Debug> From<P> for CMapBuilder<T>

Create a CMapBuilder from the VTK file specified by the path.

Panics

This function may panic if the file cannot be loaded.

fn from(value: P) -> Self

Converts to this type from the input type.