#include <AllCellsLibrary.hpp>

Inheritance diagram for AllCellsLibrary:

[legend]

Public Member Functions
	AllCellsLibrary (SimulationItem *parent)

virtual vector< int >	mapping (const Array &bv) const =0

virtual int	numEntries () const =0

Public Member Functions inherited from SimulationItem
template<class T >
T *	find (bool setup=true) const

template<class T >
T *	interface (int levels=-999999, bool setup=true) const

virtual string	itemName () const

void	setup ()

string	typeAndName () const

Public Member Functions inherited from Item
	Item (const Item &)=delete

virtual	~Item ()

void	addChild (Item *child)

const vector< Item * > &	children () const

virtual void	clearItemListProperty (const PropertyDef *property)

void	destroyChild (Item *child)

virtual bool	getBoolProperty (const PropertyDef *property) const

virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const

virtual double	getDoubleProperty (const PropertyDef *property) const

virtual string	getEnumProperty (const PropertyDef *property) const

virtual int	getIntProperty (const PropertyDef *property) const

virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const

virtual Item *	getItemProperty (const PropertyDef *property) const

virtual string	getStringProperty (const PropertyDef *property) const

int	getUtilityProperty (string name) const

virtual void	insertIntoItemListProperty (const PropertyDef property, int index, Item item)

Item &	operator= (const Item &)=delete

Item *	parent () const

virtual void	removeFromItemListProperty (const PropertyDef *property, int index)

virtual void	setBoolProperty (const PropertyDef *property, bool value)

virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)

virtual void	setDoubleProperty (const PropertyDef *property, double value)

virtual void	setEnumProperty (const PropertyDef *property, string value)

virtual void	setIntProperty (const PropertyDef *property, int value)

virtual void	setItemProperty (const PropertyDef property, Item item)

virtual void	setStringProperty (const PropertyDef *property, string value)

void	setUtilityProperty (string name, int value)

virtual string	type () const

Protected Member Functions
	AllCellsLibrary ()

vector< int >	mapping (const Array &bv) const override

int	numEntries () const override

Protected Member Functions inherited from SpatialCellLibrary
	SpatialCellLibrary ()

Protected Member Functions inherited from SimulationItem
	SimulationItem ()

virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const

virtual void	setupSelfAfter ()

virtual void	setupSelfBefore ()

Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = SpatialCellLibrary

using	ItemType = AllCellsLibrary

Friends
class	ItemRegistry

Detailed Description

The AllCellsLibrary class provides a library scheme for grouping spatial cells that has a separate entry for every cell, effectively disabling the library mechanism. This straightforward mechanism is meaningful when the corresponding calculation is fast, or as a reference for evaluating more complicated library mechanisms.

Constructor & Destructor Documentation

◆ AllCellsLibrary() [1/2]

AllCellsLibrary::AllCellsLibrary ( )

inlineprotected

Default constructor for concrete Item subclass AllCellsLibrary : "a library scheme that has a separate entry for every spatial cell" .

◆ AllCellsLibrary() [2/2]

AllCellsLibrary::AllCellsLibrary ( SimulationItem * parent )

explicit

This constructor can be invoked programmatically to create an AllCellsLibrary object. Before the constructor returns, the newly created object is hooked up as a child to the specified parent in the simulation hierarchy (so it will automatically be deleted), and its setup() function has been called.

Member Function Documentation

◆ mapping()

vector< int > AllCellsLibrary::mapping ( const Array & bv ) const

overrideprotectedvirtual

This function returns a vector nv with length $N_{cells}$ that maps each cell index $m$ to the corresponding library entry index $n_{m}$ . In this class the function returns the identity mapping.

Implements SpatialCellLibrary.

◆ numEntries()

int AllCellsLibrary::numEntries ( ) const

overrideprotectedvirtual

This function returns the number of entries in the library. In this class the function returns the number of spatial cells, i.e. $N_{entries} = N_{cells}$

Implements SpatialCellLibrary.

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

AllCellsLibrary.hpp

Public Member Functions

Protected Member Functions

Private Types