xc
Public Member Functions | List of all members
BoolArray3d Class Reference

Base class for grids of bool in 3D (used to express if something exists or not in a (layer,row,column). More...

#include <BoolArray3d.h>

Inheritance diagram for BoolArray3d:
Inheritance graph
[legend]
Collaboration diagram for BoolArray3d:
Collaboration graph
[legend]

Public Member Functions

 BoolArray3d (const size_t &n_layers, const size_t &n_rows, const size_t &n_columns, const bool &def_value=true)
 Generate the bool arrays from the arguments. More...
 
- Public Member Functions inherited from Array3dBase< m_bool >
 Array3dBase (const size_t &n_layers=0)
 Default constructor.
 
 Array3dBase (const size_t &n_layers, const m_bool &)
 Constructor.
 
 Array3dBase (const size_t &, const size_t &, const size_t &, const value_type &def_value=value_type())
 Constructor.
 
bool check_range (const size_t &, const size_t &, const size_t &) const
 
void resize (const size_t &)
 Resize the array.
 
void resize (const size_t &, const size_t &, const size_t &, const value_type &def_value=value_type())
 Resize the array.
 
size_t getNumberOfLayers (void) const
 
size_t getNumberOfRows (const size_t &layer=1) const
 
size_t getNumberOfColumns (const size_t &layer=1) const
 
size_t getNumberOfComponents (void) const
 Return the number of components in the container.
 
size_t GetDim (void) const
 
bool isIRow (void) const
 Returns true if only index I varies.
 
bool isJRow (void) const
 Returns true if only index J varies.
 
bool isKRow (void) const
 Returns true if only index K varies.
 
bool isIConstantLayer (void) const
 Returns true if the indexes that vary are los J y K.
 
bool isJConstantLayer (void) const
 Returns true if the indexes that vary are los I y K.
 
bool isKConstantLayer (void) const
 Returns true if the indexes that vary are los I y J.
 
size_t NumPtrs (void) const
 Return the number of elements of the array.
 
bool Null (void) const
 Returns true if it's empty or the pointers are null.
 
bool HasNull (void) const
 Returns true if it's empty or some of the pointers are null.
 
void clear (void)
 Clears container.
 
void dim (const size_t &, const size_t &, const size_t &, const value_type &default_value=value_type())
 Matrix dimensions.
 
const m_booloperator() (const size_t &layer) const
 Return the i-th layer.
 
m_booloperator() (const size_t &layer)
 Return the i-th layer.
 
const_reference operator() (const size_t &i, const size_t &j, const size_t &k) const
 
reference operator() (const size_t &i, const size_t &j, const size_t &k)
 
void assign (const size_t &i, const size_t &j, const size_t &k, const bool &value)
 
reference getAtI (const size_t &i)
 
const_reference getAtI (const size_t &) const
 
reference getAtIJ (const size_t &, const size_t &)
 
const_reference getAtIJ (const size_t &, const size_t &) const
 
value_type getAtIJK (const size_t &, const size_t &, const size_t &)
 
box_const_ref getBoxConstRef (size_t layer=1, size_t f=1, size_t c=1) const
 
box_const_ref getBoxConstRef (const Array3dRange &rango) const
 
constant_i_layer_const_ref getConstantILayerConstRef (size_t layer=1, size_t f=1, size_t c=1) const
 
constant_i_layer_const_ref getConstantILayerConstRef (size_t layer, const RangoIndice &, const RangoIndice &) const
 
constant_j_layer_const_ref getConstantJLayerConstRef (size_t f=1, size_t layer=1, size_t c=1) const
 
constant_j_layer_const_ref getConstantJLayerConstRef (const RangoIndice &, const size_t &f, const RangoIndice &) const
 
constant_k_layer_const_ref getConstantKLayerConstRef (size_t c=1, size_t layer=1, size_t f=1) const
 
constant_k_layer_const_ref getConstantKLayerConstRef (const RangoIndice &, const RangoIndice &, const size_t &) const
 
const_ref_i_row getIRowConstRef (size_t f=1, size_t c=1) const
 
const_ref_i_row getIRowConstRef (const RangoIndice &, const size_t &f, const size_t &c) const
 
const_ref_j_row getJRowConstRef (size_t layer=1, size_t c=1) const
 
const_ref_j_row getJRowConstRef (const size_t &layer, const RangoIndice &, const size_t &c) const
 
const_ref_k_row getKRowConstRef (size_t layer=1, size_t f=1) const
 
const_ref_k_row getKRowConstRef (const size_t &layer, const size_t &f, const RangoIndice &) const
 
box_var_ref getBoxVarRef (size_t layer=1, size_t f=1, size_t c=1)
 
box_var_ref getBoxVarRef (const Array3dRange &)
 
constant_i_layer_variable_ref getConstantILayerVarRef (size_t layer=1, size_t f=1, size_t c=1)
 
constant_i_layer_variable_ref getConstantILayerVarRef (const size_t &layer, const RangoIndice &, const RangoIndice &)
 
constant_j_layer_variable_ref getConstantJLayerVarRef (size_t f=1, size_t layer=1, size_t c=1)
 
constant_j_layer_variable_ref getConstantJLayerVarRef (const RangoIndice &, const size_t &f, const RangoIndice &)
 
constant_k_layer_variable_ref getConstantKLayerVarRef (size_t c=1, size_t layer=1, size_t f=1)
 
constant_k_layer_variable_ref getConstantKLayerVarRef (const RangoIndice &, const RangoIndice &, const size_t &c)
 
var_ref_i_row getVarRefIRow (size_t f=1, size_t c=1)
 
var_ref_i_row getVarRefIRow (const RangoIndice &, const size_t &f, const size_t &c)
 
var_ref_j_row getVarRefJRow (size_t layer=1, size_t c=1)
 
var_ref_j_row getVarRefJRow (const size_t &layer, const RangoIndice &, const size_t &c)
 
var_ref_k_row getVarRefKRow (size_t layer=1, size_t f=1)
 
var_ref_k_row getVarRefKRow (const size_t &layer, const size_t &f, const RangoIndice &)
 
void putBox (size_t layer_offset, size_t row_offset, size_t offset_col, const Array3dBase< m_bool > &)
 Put in the array the array argument.
 

Additional Inherited Members

- Public Types inherited from Array3dBase< m_bool >
typedef m_bool ::value_type value_type
 
typedef m_bool ::reference reference
 
typedef m_bool ::const_reference const_reference
 
typedef std::vector< m_bool >::value_type matrix_type
 
typedef std::vector< m_bool >::iterator iterator
 
typedef std::vector< m_bool >::const_iterator const_iterator
 
typedef Array3dBoxConstRef< Array3dBase< m_bool > > box_const_ref
 
typedef ConstantILayerConstRef< Array3dBase< m_bool > > constant_i_layer_const_ref
 
typedef ConstantJLayerConstRef< Array3dBase< m_bool > > constant_j_layer_const_ref
 
typedef ConstantKLayerConstRef< Array3dBase< m_bool > > constant_k_layer_const_ref
 
typedef IRowConstRef< Array3dBase< m_bool > > const_ref_i_row
 
typedef JRowConstRef< Array3dBase< m_bool > > const_ref_j_row
 
typedef KRowConstRef< Array3dBase< m_bool > > const_ref_k_row
 
typedef Array3dBoxVarRef< Array3dBase< m_bool > > box_var_ref
 
typedef ConstantILayerVarRef< Array3dBase< m_bool > > constant_i_layer_variable_ref
 
typedef ConstantJLayerVarRef< Array3dBase< m_bool > > constant_j_layer_variable_ref
 
typedef ConstantKLayerVarRef< Array3dBase< m_bool > > constant_k_layer_variable_ref
 
typedef IRowVarRef< Array3dBase< m_bool > > var_ref_i_row
 
typedef JRowVarRef< Array3dBase< m_bool > > var_ref_j_row
 
typedef KRowVarRef< Array3dBase< m_bool > > var_ref_k_row
 
- Protected Member Functions inherited from Array3dBase< m_bool >
matrix_type & get_layer (const size_t &iLayer)
 
const matrix_type & get_layer (const size_t &iLayer) const
 

Detailed Description

Base class for grids of bool in 3D (used to express if something exists or not in a (layer,row,column).

Constructor & Destructor Documentation

◆ BoolArray3d()

BoolArray3d::BoolArray3d ( const size_t &  n_layers,
const size_t &  n_rows,
const size_t &  n_columns,
const bool &  def_value = true 
)

Generate the bool arrays from the arguments.

Parameters
n_layersnumber of layers.
n_rowsnumber of rows for each layer.
n_columnsnumber of columns for each layer.
def_valuedefault value.

The documentation for this class was generated from the following files: