fims_popdy::SizeGrid Struct Reference

Population-level biological size grid. More...

#include <size_grid.hpp>

Public Member Functions
bool	HasStrictlyIncreasingEdges () const
	Return whether the bin edges are strictly increasing.
bool	CentersFallWithinBins () const
	Return whether each center falls inside its matching bin.
bool	IsConsistent () const
	Return whether the grid dimensions and geometry are internally consistent.

Public Attributes
std::size_t	n_bins = 0
fims::Vector< double >	edges
fims::Vector< double >	centers

Detailed Description

Population-level biological size grid.

This container defines the internal biological size support used by a population. It is intentionally separate from fleet observation bins so population size structure can be represented independently of how fleets observe it.

Member Function Documentation

CentersFallWithinBins()

bool fims_popdy::SizeGrid::CentersFallWithinBins ( ) const

inline

Return whether each center falls inside its matching bin.

Returns

True when every center is between its lower and upper bin edge.

HasStrictlyIncreasingEdges()

bool fims_popdy::SizeGrid::HasStrictlyIncreasingEdges ( ) const

inline

Return whether the bin edges are strictly increasing.

Returns

True when each edge is greater than the previous edge.

IsConsistent()

bool fims_popdy::SizeGrid::IsConsistent ( ) const

inline

Return whether the grid dimensions and geometry are internally consistent.

Returns

True when the bin counts match and the grid geometry is valid.

Member Data Documentation

centers

fims::Vector<double> fims_popdy::SizeGrid::centers

size-bin centers on the natural scale

edges

fims::Vector<double> fims_popdy::SizeGrid::edges

size-bin edges on the natural scale

n_bins

std::size_t fims_popdy::SizeGrid::n_bins = 0

number of biological size bins

---

The documentation for this struct was generated from the following file:

• inst/include/population_dynamics/size/size_grid.hpp