#include <GameOfLife.hh>

Inheritance diagram for Utopia::Models::GameOfLife::GameOfLife:

Collaboration diagram for Utopia::Models::GameOfLife::GameOfLife:

Public Types
using	Base = Model< GameOfLife, ModelTypes >
	The type of the Model base class of this derived class. More...

using	DataGroup = typename Base::DataGroup
	Data type of the group to write model data to, holding datasets. More...

using	DataSet = typename Base::DataSet
	Data type for a dataset. More...

using	CellManager = Utopia::CellManager< CellTraits, GameOfLife >
	Type of the CellManager to use. More...

using	NbLifeRule = std::unordered_set< unsigned short >
	Type of container to store the number of neighbors for the life rule. More...

using	RuleFunc = typename CellManager::RuleFunc
	Extract the type of the rule function from the CellManager. More...

Public Types inherited from Utopia::Model< GameOfLife, ModelTypes >
using	Config = typename ModelTypes::Config
	Data type that holds the configuration. More...

using	DataManager = DataIO::Default::DefaultDataManager< GameOfLife >
	The data manager to use, specialized with the derived model. More...

using	DataGroup = typename ModelTypes::DataGroup
	Data type that is used for storing datasets. More...

using	DataSet = typename ModelTypes::DataSet
	Data type that is used for storing data. More...

using	RNG = typename ModelTypes::RNG
	Data type of the shared RNG. More...

using	Space = typename ModelTypes::Space
	Data type of the space this model resides in. More...

using	Time = typename ModelTypes::Time
	Data type for the model time. More...

using	Monitor = typename ModelTypes::Monitor
	Data type for the monitor. More...

using	MonitorManager = typename ModelTypes::MonitorManager
	Data type for the monitor manager. More...

using	Level = typename ModelTypes::Level
	Data type for the hierarchical level. More...

Public Member Functions
template<class ParentModel >
	GameOfLife (const std::string name, ParentModel &parent)
	Construct the GameOfLife model. More...

void	perform_step ()
	Iterate a single step. More...

void	monitor ()
	Monitor model information. More...

void	write_data ()
	Write data. More...

Public Member Functions inherited from Utopia::Model< GameOfLife, ModelTypes >
	Model (const std::string &name, const ParentModel &parent_model, const Config &custom_cfg={}, std::tuple< WriterArgs... > w_args={}, const DataIO::Default::DefaultDecidermap< GameOfLife > &w_deciders=DataIO::Default::default_deciders< GameOfLife >, const DataIO::Default::DefaultTriggermap< GameOfLife > &w_triggers=DataIO::Default::default_triggers< GameOfLife >)
	Constructs a Model instance. More...

const std::shared_ptr< Space > &	get_space () const
	Return the space this model resides in. More...

Time	get_time () const
	Return the current time of this model. More...

Time	get_time_max () const
	Return the maximum time possible for this model. More...

Config	get_cfg () const
	Return the config node of this model. More...

std::string	get_name () const
	Return the name of this model instance. More...

std::string	get_full_name () const
	Return the full name of this model within the model hierarchy. More...

std::shared_ptr< DataGroup >	get_hdfgrp () const
	Return a pointer to the HDF group this model stores data in. More...

Time	get_write_start () const
	Return the parameter that controls when write_data is called first. More...

Time	get_write_every () const
	Return the parameter that controls how often write_data is called. More...

DataManager	get_datamanager () const
	return the datamanager More...

hsize_t	get_remaining_num_writes () const
	Return the number of remaining `write_data` calls this model will make. More...

std::shared_ptr< RNG >	get_rng () const
	Return a pointer to the shared RNG. More...

std::shared_ptr< spdlog::logger >	get_logger () const
	Return a pointer to the logger of this model. More...

Monitor	get_monitor () const
	Return the monitor of this model. More...

std::shared_ptr< MonitorManager >	get_monitor_manager () const
	Get the monitor manager of the root model. More...

Level	get_level () const
	Return the hierarchical level within the model hierarchy. More...

virtual void	prolog ()
	A function that is called before starting model iteration. More...

virtual void	epilog ()
	A function that is called after the last iteration of a model. More...

void	iterate ()
	Iterate one (time) step of this model. More...

void	run ()
	Run the model from the current time to the maximum time. More...

std::shared_ptr< DataSet >	create_dset (const std::string name, const std::shared_ptr< DataGroup > &hdfgrp, std::vector< hsize_t > add_write_shape, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a new dataset within the given group. More...

std::shared_ptr< DataSet >	create_dset (const std::string name, const std::vector< hsize_t > add_write_shape, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a new dataset within the model's base data group. More...

std::shared_ptr< DataSet >	create_cm_dset (const std::string name, const CellManager &cm, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a dataset storing data from a CellManager. More...

std::shared_ptr< DataSet >	create_am_dset (const std::string name, const AgentManager &am, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a dataset storing data from a AgentManager. More...

Private Member Functions
NbLifeRule	extract_birth_from_rule ()
	Extract the number of neighbors required for birth from the rule. More...

NbLifeRule	extract_survive_from_rule ()
	Extract the number of neighbors required to survive from the rule. More...

double	calculate_living_cell_density () const
	Calculate the mean of all cells' some_state. More...

Private Attributes
CellManager	_cm
	The cell manager. More...

const std::string	_rule
	The rule in Mirek's Cellebration notation. More...

const NbLifeRule	_birth
	The number of neighbors required to get born. More...

const NbLifeRule	_survive
	The number of neighbors required to survive. More...

std::shared_ptr< DataSet >	_dset_living
	A dataset for storing all cells living or dead status. More...

const RuleFunc	_life_rule
	Implement the general life-like rule. More...

Additional Inherited Members
Protected Member Functions inherited from Utopia::Model< GameOfLife, ModelTypes >
void	__perform_step ()
	Perform the computation of a step. More...

void	__monitor ()
	Monitor information in the terminal. More...

void	__write_data ()
	Write data; calls the implementation's write_data method. More...

void	__write_initial_state ()
	Write the initial state. More...

void	increment_time (const Time dt=1)
	Increment time. More...

void	__prolog ()
	The default prolog of a model. More...

void	__epilog ()
	The default epilog of a model. More...

GameOfLife &	impl ()
	cast to the derived class More...

const GameOfLife &	impl () const
	const cast to the derived interface More...

Protected Attributes inherited from Utopia::Model< GameOfLife, ModelTypes >
const std::string	_name
	Name of the model instance. More...

const std::string	_full_name
	The full name within the model hierarchy. More...

const Level	_level
	The level within the model hierarchy. More...

const Config	_cfg
	Config node belonging to this model instance. More...

const std::shared_ptr< RNG >	_rng
	The RNG shared between models. More...

const std::shared_ptr< spdlog::logger >	_log
	The (model) logger. More...

std::shared_ptr< Space >	_space
	The space this model resides in. More...

Time	_time
	Model-internal current time stamp. More...

const Time	_time_max
	Model-internal maximum time stamp. More...

const std::shared_ptr< DataGroup >	_hdfgrp
	The HDF group this model instance should write its data to. More...

const Time	_write_start
	First time at which write_data is called. More...

const Time	_write_every
	How often to call write_data from iterate. More...

Monitor	_monitor
	The monitor. More...

DataManager	_datamanager
	Manager object for handling data output; see DataManager. More...

Static Protected Attributes inherited from Utopia::Model< GameOfLife, ModelTypes >
static constexpr WriteMode	_write_mode
	Which data-writing mode the base model should use. More...

Detailed Description

The GameOfLife Model.

This model implement Conways Game of in the Utopia way.

Member Typedef Documentation

◆ Base

using Utopia::Models::GameOfLife::GameOfLife::Base = Model<GameOfLife, ModelTypes>

The type of the Model base class of this derived class.

◆ CellManager

using Utopia::Models::GameOfLife::GameOfLife::CellManager = Utopia::CellManager<CellTraits, GameOfLife>

Type of the CellManager to use.

◆ DataGroup

using Utopia::Models::GameOfLife::GameOfLife::DataGroup = typename Base::DataGroup

Data type of the group to write model data to, holding datasets.

◆ DataSet

using Utopia::Models::GameOfLife::GameOfLife::DataSet = typename Base::DataSet

Data type for a dataset.

◆ NbLifeRule

using Utopia::Models::GameOfLife::GameOfLife::NbLifeRule = std::unordered_set<unsigned short>

Type of container to store the number of neighbors for the life rule.

◆ RuleFunc

using Utopia::Models::GameOfLife::GameOfLife::RuleFunc = typename CellManager::RuleFunc

Extract the type of the rule function from the CellManager.

This is a function that receives a reference to a cell and returns the new cell state. For more details, check out Utopia::CellManager

Note: Whether the cell state gets applied directly or requires a synchronous update depends on the update mode specified in the cell traits.

Constructor & Destructor Documentation

◆ GameOfLife()

template<class ParentModel >

Utopia::Models::GameOfLife::GameOfLife::GameOfLife	(	const std::string	name,
		ParentModel &	parent
	)

inline

Construct the GameOfLife model.

Parameters

name	Name of this model instance
parent	The parent model this model instance resides in

Member Function Documentation

◆ calculate_living_cell_density()

double Utopia::Models::GameOfLife::GameOfLife::calculate_living_cell_density ( ) const

inlineprivate

Calculate the mean of all cells' some_state.

◆ extract_birth_from_rule()

NbLifeRule Utopia::Models::GameOfLife::GameOfLife::extract_birth_from_rule ( )

inlineprivate

Extract the number of neighbors required for birth from the rule.

◆ extract_survive_from_rule()

NbLifeRule Utopia::Models::GameOfLife::GameOfLife::extract_survive_from_rule ( )

inlineprivate

Extract the number of neighbors required to survive from the rule.

◆ monitor()

void Utopia::Models::GameOfLife::GameOfLife::monitor ( )

inline

Monitor model information.

Here, functions and values can be supplied to the monitor that are then available to the frontend. The monitor() function is only called if a certain emit interval has passed; thus, the performance hit is small. With this information, you can then define stop conditions on frontend side, that can stop a simulation once a certain set of conditions is fulfilled.

◆ perform_step()

void Utopia::Models::GameOfLife::GameOfLife::perform_step ( )

inline

Iterate a single step.

◆ write_data()

void Utopia::Models::GameOfLife::GameOfLife::write_data ( )

inline

Write data.

This function is called to write out data. The configuration determines the times at which it is invoked. See Utopia::DataIO::Dataset::write

Member Data Documentation

◆ _birth

const NbLifeRule Utopia::Models::GameOfLife::GameOfLife::_birth

private

The number of neighbors required to get born.

◆ _cm

CellManager Utopia::Models::GameOfLife::GameOfLife::_cm

private

The cell manager.

◆ _dset_living

std::shared_ptr<DataSet> Utopia::Models::GameOfLife::GameOfLife::_dset_living

private

A dataset for storing all cells living or dead status.

◆ _life_rule

const RuleFunc Utopia::Models::GameOfLife::GameOfLife::_life_rule

private

Implement the general life-like rule.

◆ _rule

const std::string Utopia::Models::GameOfLife::GameOfLife::_rule

private

The rule in Mirek's Cellebration notation.

◆ _survive

const NbLifeRule Utopia::Models::GameOfLife::GameOfLife::_survive

private

The number of neighbors required to survive.

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

src/utopia/models/GameOfLife/GameOfLife.hh

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ CellManager

◆ DataGroup

◆ DataSet

◆ NbLifeRule

◆ RuleFunc

Constructor & Destructor Documentation

◆ GameOfLife()

Member Function Documentation

◆ calculate_living_cell_density()

◆ extract_birth_from_rule()

◆ extract_survive_from_rule()

◆ monitor()

◆ perform_step()

◆ write_data()

Member Data Documentation

◆ _birth

◆ _cm

◆ _dset_living

◆ _life_rule

◆ _rule

◆ _survive