Three dimensional array class designed to be defined as instance member in recursive_configurable class. More...

#include <array3.h>

Inheritance diagram for array3< T >:

Classes
class	const_iterator
	Read-only iterator. More...

class	iterator
	Writable iterator. More...

struct	type3
	Collection of properties of this grid. More...

Public Types
enum	{ ACTIVES = true, ALL = false }

Public Types inherited from configurable
using	environment_map = std::map< std::string, const void * >
	Type for environment_map.

Public Member Functions
	array3 (recursive_configurable *parent, const shape3 &shape, T value=T(), std::string core_name="")
	Constructor for array3. More...

	array3 (recursive_configurable *parent, std::string core_name="")
	Constructor for array3. More...

	array3 (std::string core_name="")
	Constructor for array3. More...

	array3 (const shape3 &shape, T value=T(), std::string core_name="")
	Constructor for array3. More...

virtual bool	send_message (std::string message, void *ptr) override
	Send a message to the core module. More...

virtual bool	const_send_message (std::string message, void *ptr) const override
	Send a message to the core module. More...

	array3 (const array3 &array)
	Copy constructor for array3. More...

void	set_touch_only_actives (bool touch_only_actives)
	Set whether to force grid manipulation only on active cells. If true, operatios such `operator+=()` only acts on active cells. More...

array3 &	operator= (const array3 &array)
	Deep copy operation for array3. More...

void	copy (const array3 &array)
	Deep copy function for array3. More...

std::vector< T >	linearize () const
	Flatten this grid to a fully linearized one dimendional array, of which can be accessed like `array[i+jw+k(w*h)]`. More...

shape3	shape () const
	Get the shape of the array. More...

void	initialize (const shape3 &shape, T value=T())
	Allocate grid memory with value. More...

void	set_as_levelset (double bandwidth_half)
	Set the grid as level set. More...

void	set_as_fillable (const T &fill_value)
	Set the grid as a grid that is fillable by flood fill. More...

void	set_as_fillable_as (const array3 &array)
	Set the grid as fillable as same as an input array. More...

void	set_as_levelset_as (const array3 &array)
	Set the grid as level set as same as an input array. More...

bool	is_fillable () const
	Return if the grid is set fillable. More...

bool	is_levelset () const
	Return if the grid is set level set. More...

void	flood_fill ()
	Perform flood fill. Grid should be set either level set of fillable beforehand.

std::vector< vec3i >	fills () const
	Function to return the list of filled cells. More...

bool	filled (int i, int j, int k) const
	Function to get if a cell is filled. More...

bool	filled (const vec3i &pi) const
	Function to get if a cell is filled. More...

size_t	count () const
	Function to count the number of active cells. More...

std::vector< vec3i >	actives () const
	Function to return the list of active cells positions. More...

void	activate (const std::vector< vec3i > &active_entries, const vec3i &offset=vec3i())
	Activate cells at the positons of active_entries with an offset. More...

template<class Y >
void	activate_as (const array3< Y > &array, const vec3i &offset=vec3i())
	Activate cells at the same positons where an input array is active with an offset. More...

template<class Y >
void	activate_as_bit (const Y &array, const vec3i &offset=vec3i())
	Activate cells at the same positons where an input array is active with an offset. More...

template<class Y >
void	activate_inside_as (const array3< Y > &array, const vec3i &offset=vec3i())
	Activate cells at the same positons where an input array is filled with an offset. More...

void	activate_all ()
	Activate all the cells.

void	activate_inside ()
	Activate all the filled cells.

template<class Y >
void	copy_active_as (const array3< Y > &array, const vec3i &offset=vec3i())
	Copy the states of active and inactive cells as same as input array with an offset. More...

T	get_background_value () const
	Get the background value (alternatively, initial value) of the grid.

void	set_background_value (const T &value)
	Set the background value (alternatively, initial value) of the grid. More...

void	clear ()
	Clear out the grid. More...

void	clear (const T &v)
	Clear out the grid with the new backgroud value. More...

void	set (int i, int j, int k, const T &value)
	Set value on grid. More...

void	set (const vec3i &pi, const T &value)
	Set value on grid. More...

bool	active (int i, int j, int k) const
	Get if a position on grid is active. More...

bool	active (const vec3i &pi) const
	Get if a position on grid is active. More...

bool	safe_active (int i, int j, int k) const
	Get if a position on grid is active. (i,j,k) can be safely out of the domain. More...

bool	safe_active (const vec3i &pi) const
	Get if a position on grid is active. pi can be safely out of the domain. More...

void	set_off (int i, int j, int k)
	Set a position on grid inactive. More...

void	set_off (const vec3i &pi)
	Set a position on grid inactive. More...

void	increment (int i, int j, int k, const T &value)
	Increment value on grid. More...

void	increment (const vec3i &pi, const T &value)
	Increment value on grid. More...

void	subtract (int i, int j, int k, const T &value)
	Subtract value on grid. More...

void	subtract (const vec3i &pi, const T &value)
	Subtract value on grid. More...

void	multiply (int i, int j, int k, const T &value)
	Multiply value on grid. More...

void	multiply (const vec3i &pi, const T &value)
	Multiply value on grid. More...

void	devide (int i, int j, int k, const T &value)
	Divide by value on grid. More...

void	devide (const vec3i &pi, const T &value)
	Divide by value on grid. More...

T *	ptr (unsigned i, unsigned j, unsigned k)
	Get the pointer to the value at a position on grid. More...

const T *	ptr (unsigned i, unsigned j, unsigned k) const
	Get the const pointer to the value at a position on grid. More...

T *	ptr (const vec3i &pi)
	Get the pointer to the value at a position on grid. More...

const T *	ptr (const vec3i &pi) const
	Get the const pointer to the value at a position on grid. More...

const T &	operator() (int i, int j, int k) const
	Get the the value at a position on grid. More...

const T &	operator() (const vec3i &pi) const
	Get the the value at a position on grid. More...

bool	operator!= (const array3< T > &array) const
	Return if the grid is different from an input array. More...

bool	operator== (const array3< T > &v) const
	Return if the grid is same to an input array. More...

void	operator= (const T &v)
	Set all the grid values with an input value. More...

void	operator+= (const array3< T > &v)
	Increment all the values with the values of an input array. More...

void	operator-= (const array3< T > &v)
	Subtract all the values with the values of an input array. More...

void	operator+= (const T &v)
	Increment all the grid values with an input value. More...

void	operator-= (const T &v)
	Subtract all the grid values with an input value. More...

void	operator*= (const T &v)
	Multiply all the grid values with an input value. More...

void	operator/= (const T &v)
	Divide all the grid values with an input value. More...

void	set_thread_num (int number)
	Set the number of threads for parallel processing on this grid. More...

int	get_thread_num () const
	Get the current number of threads for parallel processing on this grid. More...

void	parallel_actives (std::function< void(iterator &it)> func)
	Loop over all the active cells in parallel. More...

void	parallel_all (std::function< void(iterator &it)> func)
	Loop over all the cells in parallel. More...

void	parallel_op (std::function< void(iterator &it)> func, bool type=ALL)
	Loop over cells in parallel. More...

void	parallel_actives (std::function< void(int i, int j, int k, iterator &it)> func)
	Loop over all the active cells in parallel. More...

void	parallel_all (std::function< void(int i, int j, int k, iterator &it)> func)
	Loop over all the cells in parallel. More...

void	parallel_op (std::function< void(int i, int j, int k, iterator &it)> func, bool type=ALL)
	Loop over cells in parallel. More...

void	parallel_actives (std::function< void(int i, int j, int k, iterator &it, int thread_index)> func)
	Loop over all the active cells in parallel. More...

void	parallel_all (std::function< void(int i, int j, int k, iterator &it, int thread_index)> func)
	Loop over all the cells in parallel. More...

void	parallel_op (std::function< void(int i, int j, int k, iterator &it, int thread_index)> func, bool type=ALL)
	Loop over cells in parallel. More...

void	const_parallel_actives (std::function< void(const const_iterator &it)> func) const
	Loop over all the active cells in parallel by read-only fashion. More...

void	const_parallel_all (std::function< void(const const_iterator &it)> func) const
	Loop over all the cells in parallel by read-only fashion. More...

void	const_parallel_op (std::function< void(const const_iterator &it)> func, bool type=ALL) const
	Loop over cells in parallel by read-only fashion. More...

void	const_parallel_inside (std::function< void(const const_iterator &it)> func) const
	Loop over all the filled cells in parallel by read-only fashion. More...

void	const_parallel_actives (std::function< void(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the active cells in parallel by read-only fashion. More...

void	const_parallel_all (std::function< void(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the cells in parallel by read-only fashion. More...

void	const_parallel_op (std::function< void(int i, int j, int k, const const_iterator &it)> func, bool type=ALL) const
	Loop over cells in parallel by read-only fashion. More...

void	const_parallel_inside (std::function< void(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the filled cells in parallel by read-only fashion. More...

void	const_parallel_actives (std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)> func) const
	Loop over all the active cells in parallel by read-only fashion. More...

void	const_parallel_all (std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)> func) const
	Loop over all the cells in parallel by read-only fashion. More...

void	const_parallel_op (std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)> func, bool type=ALL) const
	Loop over cells in parallel by read-only fashion. More...

void	const_parallel_inside (std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)> func) const
	Loop over all the filled cells in parallel. More...

void	serial_actives (std::function< void(iterator &it)> func)
	Loop over all the active cells in serial order. More...

void	serial_all (std::function< void(iterator &it)> func)
	Loop over all the cells in serial order. More...

void	serial_op (std::function< void(iterator &it)> func, bool type=ALL)
	Loop over cells in serial order. More...

void	serial_actives (std::function< void(int i, int j, int k, iterator &it)> func)
	Loop over all the active cells in serial order. More...

void	serial_all (std::function< void(int i, int j, int k, iterator &it)> func)
	Loop over all the cells in serial order. More...

void	serial_op (std::function< void(int i, int j, int k, iterator &it)> func, bool type=ALL)
	Loop over cells in serial order. More...

void	const_serial_actives (std::function< void(const const_iterator &it)> func) const
	Loop over all the active cells in serial order by read-only fashion. More...

void	const_serial_all (std::function< void(const const_iterator &it)> func) const
	Loop over all the cells in serial order by read-only fashion. More...

void	const_serial_op (std::function< void(const const_iterator &it)> func, bool type=ALL) const
	Loop over the cells in serial order by read-only fashion. More...

void	const_serial_inside (std::function< void(const const_iterator &it)> func) const
	Loop over filled the cells in serial order by read-only fashion. More...

void	const_serial_actives (std::function< void(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the active cells in serial order by read-only fashion. More...

void	const_serial_all (std::function< void(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the cells in serial order by read-only fashion. More...

void	const_serial_op (std::function< void(int i, int j, int k, const const_iterator &it)> func, bool type=ALL) const
	Loop over cells in serial order by read-only fashion. More...

void	const_serial_inside (std::function< void(int i, int j, int k, const const_iterator &it)> func) const
	Loop over filled the cells in serial order by read-only fashion. More...

void	interruptible_serial_actives (std::function< bool(iterator &it)> func)
	Loop over all the active cells in serial order. More...

void	interruptible_serial_all (std::function< bool(iterator &it)> func)
	Loop over all the cells in serial order. More...

void	interruptible_serial_op (std::function< bool(iterator &it)> func, bool type=ALL)
	Loop over cells in serial order. More...

void	interruptible_serial_actives (std::function< bool(int i, int j, int k, iterator &it)> func)
	Loop over all the active cells in serial order. More...

void	interruptible_serial_all (std::function< bool(int i, int j, int k, iterator &it)> func)
	Loop over all the cells in serial order. More...

void	interruptible_serial_op (std::function< bool(int i, int j, int k, iterator &it)> func, bool type=ALL)
	Loop over cells in serial order. More...

void	interruptible_const_serial_actives (std::function< bool(const const_iterator &it)> func) const
	Loop over all the active cells in serial order by read-only fashion. More...

void	interruptible_const_serial_all (std::function< bool(const const_iterator &it)> func) const
	Loop over all the cells in serial order by read-only fashion. More...

void	interruptible_const_serial_op (std::function< bool(const const_iterator &it)> func, bool type=ALL) const
	Loop over cells in serial order by read-only fashion. More...

void	interruptible_const_serial_inside (std::function< bool(const const_iterator &it)> func, bool type=ALL) const
	Loop over all the filled cells in serial order by read-only fashion. More...

void	interruptible_const_serial_actives (std::function< bool(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the active cells in serial order by read-only fashion. More...

void	interruptible_const_serial_all (std::function< bool(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the cells in serial order by read-only fashion. More...

void	interruptible_const_serial_op (std::function< bool(int i, int j, int k, const const_iterator &it)> func, bool type=ALL) const
	Loop over cells in serial order by read-only fashion. More...

void	interruptible_const_serial_inside (std::function< bool(int i, int j, int k, const const_iterator &it)> func) const
	Loop over all the filled cells in serial order by read-only fashion. More...

void	dilate (std::function< void(int i, int j, int k, iterator &it, int thread_index)> func, int count=1)
	Dilate cells. More...

void	dilate (std::function< void(int i, int j, int k, iterator &it)> func, int count=1)
	Dilate cells. More...

void	dilate (int count=1)
	Dilate cells. More...

void	erode (std::function< bool(int i, int j, int k, const const_iterator &it, int thread_index)> func, int count=1)
	Erode cells. More...

void	erode (std::function< bool(int i, int j, int k, const const_iterator &it)> func, int count=1)
	Erode cells. More...

void	erode (int count=1)
	Erode cells. More...

void	swap (array3 &rhs)
	Swap array. More...

parallel_driver &	get_parallel_driver ()
	Get the instance of `parallel_driver` of this grid. More...

const parallel_driver &	get_parallel_driver () const
	Get the const instance of `parallel_driver` of this grid. More...

void	set_core_name (std::string core_name)
	Set the core name of module of this grid. More...

std::string	get_core_name () const
	Get the core name of module of this grid. More...

const array_core3 *	get_core () const
	Get pointer to the core module. More...

array_core3 *	get_core ()
	Get pointer to the core module. More...

type3	type () const
	Get the type of this grid. More...

void	set_type (const type3 &type)
	Set the type of this grid. More...

Public Member Functions inherited from recursive_configurable
	recursive_configurable ()=default
	Default constructor.

virtual void	recursive_load (configuration &config)
	Load the program itself and relay the same to its children. Used to load files and libraries into memory. More...

virtual void	recursive_configure (configuration &config)
	Configure the program itself and relay the same to its children. Used to load and set parameters. More...

virtual void	recursive_initialize (const configurable::environment_map &environment=configurable::environment_map())
	Initialize the program itself and relay the same to its children. Used to get things ready for actual use. More...

virtual bool	is_ready () const
	Get if the instance is initialized. More...

virtual void	add_child (configurable *child)
	Add a child instance. More...

virtual void	add_child (recursive_configurable *child)
	Add a child instance. More...

virtual void	remove_child (configurable *child)
	Remove a child instance. More...

virtual void	remove_child (recursive_configurable *child)
	Remove a child instance. More...

virtual void	setup_now (configuration &config=get_global_configuration()) override
	Run recursive_load - recursive_configure - recursive_initialize processes.

virtual bool	not_recursive () override
	Check if this instance is not derived from recursive_configurable. More...

void	set_environment (std::string name, const void *value)
	Set the pointer to an environmental value associated with an input name. More...

Additional Inherited Members
Static Public Member Functions inherited from configurable
static configuration &	set_global_configuration (const configuration &config)
	Assign the global settings of the program. More...

static configuration &	get_global_configuration ()
	Get the global settings of the program. More...

template<class T >
static const T &	get_env (const environment_map &environment, std::string key)
	Extract an specified type of pointer from the input environment. More...

Protected Member Functions inherited from configurable
bool	check_set (const environment_map &environment, std::vector< std::string > names)
	Check if the values for a variable keys exist. More...

Detailed Description

template<class T>
class array3< T >

Three dimensional array class designed to be defined as instance member in recursive_configurable class.

Constructor & Destructor Documentation

◆ array3() [1/5]

template<class T >

array3< T >::array3	(	recursive_configurable *	parent,
		const shape3 &	shape,
		T	value = `T()`,
		std::string	core_name = `""`
	)

inline

Constructor for array3.

Parameters

[in]	parent	Pointer to a parent recursive_configurable instance. Can be nullptr.
[in]	shape	Shape of the grid
[in]	value	Background value (initial value).
[in]	core_name	Core module name. Default value is "tiledarray_core3".

◆ array3() [2/5]

template<class T >

array3< T >::array3	(	recursive_configurable *	parent,
		std::string	core_name = `""`
	)

inline

Constructor for array3.

Parameters

[in]	parent	Pointer to a parent recursive_configurable instance. Can be nullptr.
[in]	core_name	Core module name. Default value is "tiledarray_core3".

◆ array3() [3/5]

template<class T >

array3< T >::array3 ( std::string core_name = "" )

inline

Constructor for array3.

Parameters

[in] core_name Core module name. Default value is "tiledarray_core3".

◆ array3() [4/5]

template<class T >

array3< T >::array3	(	const shape3 &	shape,
		T	value = `T()`,
		std::string	core_name = `""`
	)

inline

Constructor for array3.

Parameters

[in]	shape	Shape of the grid
[in]	value	Background value (initial value).
[in]	core_name	Core module name. Default value is "tiledarray_core3".

◆ array3() [5/5]

template<class T >

array3< T >::array3 ( const array3< T > & array )

inline

Copy constructor for array3.

Parameters

[in] array Reference to an instance of array to copy from.

Member Function Documentation

◆ activate()

template<class T >

void array3< T >::activate	(	const std::vector< vec3i > &	active_entries,
		const vec3i &	offset = `vec3i()`
	)

inline

Activate cells at the positons of active_entries with an offset.

Parameters

[in]	active_entries	The list of target positions to activate.
[in]	offset	Offset applied to the active_entries.

◆ activate_as()

template<class T >

template<class Y >

void array3< T >::activate_as	(	const array3< Y > &	array,
		const vec3i &	offset = `vec3i()`
	)

inline

Activate cells at the same positons where an input array is active with an offset.

Parameters

[in]	array	Target array.
[in]	offset	Offset applied to the target array.

◆ activate_as_bit()

template<class T >

template<class Y >

void array3< T >::activate_as_bit	(	const Y &	array,
		const vec3i &	offset = `vec3i()`
	)

inline

Activate cells at the same positons where an input array is active with an offset.

Parameters

[in]	array	Target array.
[in]	offset	Offset applied to the target array.

◆ activate_inside_as()

template<class T >

template<class Y >

void array3< T >::activate_inside_as	(	const array3< Y > &	array,
		const vec3i &	offset = `vec3i()`
	)

inline

Activate cells at the same positons where an input array is filled with an offset.

Parameters

[in]	array	Target array.
[in]	offset	Offset applied to the target array.

◆ active() [1/2]

template<class T >

bool array3< T >::active ( const vec3i & pi ) const

inline

Get if a position on grid is active.

Parameters

[in] pi position on grid.

Returns: true if active flase if inactive.

◆ active() [2/2]

template<class T >

bool array3< T >::active	(	int	i,
		int	j,
		int	k
	)		const

inline

Get if a position on grid is active.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate

Returns: true if active flase if inactive.

◆ actives()

template<class T >

std::vector<vec3i> array3< T >::actives ( ) const

inline

Function to return the list of active cells positions.

Returns: The list of active cells positions.

◆ clear() [1/2]

template<class T >

void array3< T >::clear ( )

inline

Clear out the grid.

Note that size, the memory allocation, background values and the information regarding level set or fillable left intact.

◆ clear() [2/2]

template<class T >

void array3< T >::clear ( const T & v )

inline

Clear out the grid with the new backgroud value.

Background values regarding level set and the fillable will be dicarded. Size and the memory allocation left intact.

◆ const_parallel_actives() [1/3]

template<class T >

void array3< T >::const_parallel_actives ( std::function< void(const const_iterator &it)> func ) const

inline

Loop over all the active cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_actives() [2/3]

template<class T >

void array3< T >::const_parallel_actives ( std::function< void(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the active cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_actives() [3/3]

template<class T >

void array3< T >::const_parallel_actives ( std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)> func ) const

inline

Loop over all the active cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_all() [1/3]

template<class T >

void array3< T >::const_parallel_all ( std::function< void(const const_iterator &it)> func ) const

inline

Loop over all the cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_all() [2/3]

template<class T >

void array3< T >::const_parallel_all ( std::function< void(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_all() [3/3]

template<class T >

void array3< T >::const_parallel_all ( std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)> func ) const

inline

Loop over all the cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_inside() [1/3]

template<class T >

void array3< T >::const_parallel_inside ( std::function< void(const const_iterator &it)> func ) const

inline

Loop over all the filled cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_inside() [2/3]

template<class T >

void array3< T >::const_parallel_inside ( std::function< void(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the filled cells in parallel by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_inside() [3/3]

template<class T >

void array3< T >::const_parallel_inside ( std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)> func ) const

inline

Loop over all the filled cells in parallel.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_parallel_op() [1/3]

template<class T >

void array3< T >::const_parallel_op	(	std::function< void(const const_iterator &it)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over cells in parallel by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ const_parallel_op() [2/3]

template<class T >

void array3< T >::const_parallel_op	(	std::function< void(int i, int j, int k, const const_iterator &it)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over cells in parallel by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ const_parallel_op() [3/3]

template<class T >

void array3< T >::const_parallel_op	(	std::function< void(int i, int j, int k, const const_iterator &it, int thread_index)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over cells in parallel by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ const_send_message()

template<class T >

virtual bool array3< T >::const_send_message	(	std::string	message,
		void *	ptr
	)		const

inlineoverridevirtual

Send a message to the core module.

Parameters

[in]	message	Message
[in]	ptr	Pointer to some value.

Returns: true if handled false otherwise.

Reimplemented from messageable.

◆ const_serial_actives() [1/2]

template<class T >

void array3< T >::const_serial_actives ( std::function< void(const const_iterator &it)> func ) const

inline

Loop over all the active cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_serial_actives() [2/2]

template<class T >

void array3< T >::const_serial_actives ( std::function< void(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the active cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_serial_all() [1/2]

template<class T >

void array3< T >::const_serial_all ( std::function< void(const const_iterator &it)> func ) const

inline

Loop over all the cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_serial_all() [2/2]

template<class T >

void array3< T >::const_serial_all ( std::function< void(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_serial_inside() [1/2]

template<class T >

void array3< T >::const_serial_inside ( std::function< void(const const_iterator &it)> func ) const

inline

Loop over filled the cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_serial_inside() [2/2]

template<class T >

void array3< T >::const_serial_inside ( std::function< void(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over filled the cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ const_serial_op() [1/2]

template<class T >

void array3< T >::const_serial_op	(	std::function< void(const const_iterator &it)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over the cells in serial order by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ const_serial_op() [2/2]

template<class T >

void array3< T >::const_serial_op	(	std::function< void(int i, int j, int k, const const_iterator &it)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over cells in serial order by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ copy()

template<class T >

void array3< T >::copy ( const array3< T > & array )

inline

Deep copy function for array3.

Parameters

[in] array Reference to an instance of array to copy from.

◆ copy_active_as()

template<class T >

template<class Y >

void array3< T >::copy_active_as	(	const array3< Y > &	array,
		const vec3i &	offset = `vec3i()`
	)

inline

Copy the states of active and inactive cells as same as input array with an offset.

Parameters

[in]	array	Target input array from which the states to be copied.
[in]	offset	Offset

◆ count()

template<class T >

size_t array3< T >::count ( ) const

inline

Function to count the number of active cells.

Returns: Active cell count.

◆ devide() [1/2]

template<class T >

void array3< T >::devide	(	const vec3i &	pi,
		const T &	value
	)

inline

Divide by value on grid.

Parameters

[in]	pi	position on grid.
[in]	value	Value to divide at the position.

◆ devide() [2/2]

template<class T >

void array3< T >::devide	(	int	i,
		int	j,
		int	k,
		const T &	value
	)

inline

Divide by value on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate
[in]	value	Value to divide at the position.

◆ dilate() [1/3]

template<class T >

void array3< T >::dilate ( int count = 1 )

inline

Dilate cells.

Parameters

[in] count Number of dilation count.

◆ dilate() [2/3]

template<class T >

void array3< T >::dilate	(	std::function< void(int i, int j, int k, iterator &it)>	func,
		int	count = `1`
	)

inline

Dilate cells.

Parameters

[in]	func	Function that specifies what value to assign on dilated cells.
[in]	count	Number of dilation count.

◆ dilate() [3/3]

template<class T >

void array3< T >::dilate	(	std::function< void(int i, int j, int k, iterator &it, int thread_index)>	func,
		int	count = `1`
	)

inline

Dilate cells.

Parameters

[in]	func	Function that specifies what value to assign on dilated cells.
[in]	count	Number of dilation count.

◆ erode() [1/3]

template<class T >

void array3< T >::erode ( int count = 1 )

inline

Erode cells.

Parameters

[in] count Number of erode count.

◆ erode() [2/3]

template<class T >

void array3< T >::erode	(	std::function< bool(int i, int j, int k, const const_iterator &it)>	func,
		int	count = `1`
	)

inline

Erode cells.

Parameters

[in]	func	Function that specifies whether to inactivate the cell.
[in]	count	Number of erode count.

◆ erode() [3/3]

template<class T >

void array3< T >::erode	(	std::function< bool(int i, int j, int k, const const_iterator &it, int thread_index)>	func,
		int	count = `1`
	)

inline

Erode cells.

Parameters

[in]	func	Function that specifies whether to inactivate the cell.
[in]	count	Number of erode count.

◆ filled() [1/2]

template<class T >

bool array3< T >::filled ( const vec3i & pi ) const

inline

Function to get if a cell is filled.

Parameters

[in] pi position.

Returns: true if the cell is filled false if not.

◆ filled() [2/2]

template<class T >

bool array3< T >::filled	(	int	i,
		int	j,
		int	k
	)		const

inline

Function to get if a cell is filled.

Parameters

[in]	i	x coordinate position.
[in]	j	y coordinate position.
[in]	k	z coordinate position.

Returns: true if the cell is filled false if not.

◆ fills()

template<class T >

std::vector<vec3i> array3< T >::fills ( ) const

inline

Function to return the list of filled cells.

Returns: The list of filled cells.

◆ get_core() [1/2]

template<class T >

array_core3* array3< T >::get_core ( )

inline

Get pointer to the core module.

Returns: Pointer to the core module.

◆ get_core() [2/2]

template<class T >

const array_core3* array3< T >::get_core ( ) const

inline

Get pointer to the core module.

Returns: Pointer to the core module.

◆ get_core_name()

template<class T >

std::string array3< T >::get_core_name ( ) const

inline

Get the core name of module of this grid.

Returns: Name of the core name.

◆ get_parallel_driver() [1/2]

template<class T >

parallel_driver& array3< T >::get_parallel_driver ( )

inline

Get the instance of parallel_driver of this grid.

Returns: Instance of parallel_driver of this grid.

◆ get_parallel_driver() [2/2]

template<class T >

const parallel_driver& array3< T >::get_parallel_driver ( ) const

inline

Get the const instance of parallel_driver of this grid.

Returns: Const instance of parallel_driver of this grid.

◆ get_thread_num()

template<class T >

int array3< T >::get_thread_num ( ) const

inline

Get the current number of threads for parallel processing on this grid.

Returns: number Number of threads.

◆ increment() [1/2]

template<class T >

void array3< T >::increment	(	const vec3i &	pi,
		const T &	value
	)

inline

Increment value on grid.

Parameters

[in]	pi	position on grid
[in]	value	Value to increment at the position.

◆ increment() [2/2]

template<class T >

void array3< T >::increment	(	int	i,
		int	j,
		int	k,
		const T &	value
	)

inline

Increment value on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate
[in]	value	Value to increment at the position.

◆ initialize()

template<class T >

void array3< T >::initialize	(	const shape3 &	shape,
		T	value = `T()`
	)

inline

Allocate grid memory with value.

Parameters

[in]	shape	Shape or the grid.
[in]	value	Initial value

◆ interruptible_const_serial_actives() [1/2]

template<class T >

void array3< T >::interruptible_const_serial_actives ( std::function< bool(const const_iterator &it)> func ) const

inline

Loop over all the active cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_const_serial_actives() [2/2]

template<class T >

void array3< T >::interruptible_const_serial_actives ( std::function< bool(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the active cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_const_serial_all() [1/2]

template<class T >

void array3< T >::interruptible_const_serial_all ( std::function< bool(const const_iterator &it)> func ) const

inline

Loop over all the cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_const_serial_all() [2/2]

template<class T >

void array3< T >::interruptible_const_serial_all ( std::function< bool(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_const_serial_inside() [1/2]

template<class T >

void array3< T >::interruptible_const_serial_inside	(	std::function< bool(const const_iterator &it)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over all the filled cells in serial order by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed. Stop the loop if return true.
[in]	type	Type of target cells. ACTIVE or ALL. Stop the loop if return true.

◆ interruptible_const_serial_inside() [2/2]

template<class T >

void array3< T >::interruptible_const_serial_inside ( std::function< bool(int i, int j, int k, const const_iterator &it)> func ) const

inline

Loop over all the filled cells in serial order by read-only fashion.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_const_serial_op() [1/2]

template<class T >

void array3< T >::interruptible_const_serial_op	(	std::function< bool(const const_iterator &it)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over cells in serial order by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed. Stop the loop if return true.
[in]	type	Type of target cells. ACTIVE or ALL. Stop the loop if return true.

◆ interruptible_const_serial_op() [2/2]

template<class T >

void array3< T >::interruptible_const_serial_op	(	std::function< bool(int i, int j, int k, const const_iterator &it)>	func,
		bool	type = `ALL`
	)		const

inline

Loop over cells in serial order by read-only fashion.

Parameters

[in]	func	Function that defines how each grid cell is processed. Stop the loop if return true.
[in]	type	Type of target cells. ACTIVE or ALL. Stop the loop if return true.

◆ interruptible_serial_actives() [1/2]

template<class T >

void array3< T >::interruptible_serial_actives ( std::function< bool(int i, int j, int k, iterator &it)> func )

inline

Loop over all the active cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_serial_actives() [2/2]

template<class T >

void array3< T >::interruptible_serial_actives ( std::function< bool(iterator &it)> func )

inline

Loop over all the active cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_serial_all() [1/2]

template<class T >

void array3< T >::interruptible_serial_all ( std::function< bool(int i, int j, int k, iterator &it)> func )

inline

Loop over all the cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_serial_all() [2/2]

template<class T >

void array3< T >::interruptible_serial_all ( std::function< bool(iterator &it)> func )

inline

Loop over all the cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed. Stop the loop if return true.

◆ interruptible_serial_op() [1/2]

template<class T >

void array3< T >::interruptible_serial_op	(	std::function< bool(int i, int j, int k, iterator &it)>	func,
		bool	type = `ALL`
	)

inline

Loop over cells in serial order.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL. Stop the loop if return true.

◆ interruptible_serial_op() [2/2]

template<class T >

void array3< T >::interruptible_serial_op	(	std::function< bool(iterator &it)>	func,
		bool	type = `ALL`
	)

inline

Loop over cells in serial order.

Parameters

[in]	func	Function that defines how each grid cell is processed. Stop the loop if return true.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ is_fillable()

template<class T >

bool array3< T >::is_fillable ( ) const

inline

Return if the grid is set fillable.

Returns: Whether the grid is set fillable.

◆ is_levelset()

template<class T >

bool array3< T >::is_levelset ( ) const

inline

Return if the grid is set level set.

Returns: Whether the grid is set level set.

◆ linearize()

template<class T >

std::vector<T> array3< T >::linearize ( ) const

inline

Flatten this grid to a fully linearized one dimendional array, of which can be accessed like array[i+j*w+k*(w*h)].

Returns: Flattened linearized array.

◆ multiply() [1/2]

template<class T >

void array3< T >::multiply	(	const vec3i &	pi,
		const T &	value
	)

inline

Multiply value on grid.

Parameters

[in]	pi	position on grid.
[in]	value	Value to multiply at the position.

◆ multiply() [2/2]

template<class T >

void array3< T >::multiply	(	int	i,
		int	j,
		int	k,
		const T &	value
	)

inline

Multiply value on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate
[in]	value	Value to multiply at the position.

◆ operator!=()

template<class T >

bool array3< T >::operator!= ( const array3< T > & array ) const

inline

Return if the grid is different from an input array.

Parameters

[in] array Target array to compare.

Returns: true if the array is different from the input array and false otherwise.

◆ operator()() [1/2]

template<class T >

const T& array3< T >::operator() ( const vec3i & pi ) const

inline

Get the the value at a position on grid.

Parameters

[in] pi position on grid.

◆ operator()() [2/2]

template<class T >

const T& array3< T >::operator()	(	int	i,
		int	j,
		int	k
	)		const

inline

Get the the value at a position on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate

◆ operator*=()

template<class T >

void array3< T >::operator*= ( const T & v )

inline

Multiply all the grid values with an input value.

Parameters

[in] v Value to multiply.

◆ operator+=() [1/2]

template<class T >

void array3< T >::operator+= ( const array3< T > & v )

inline

Increment all the values with the values of an input array.

Parameters

[in] v Input array.

◆ operator+=() [2/2]

template<class T >

void array3< T >::operator+= ( const T & v )

inline

Increment all the grid values with an input value.

Parameters

[in] v Value to increment.

◆ operator-=() [1/2]

template<class T >

void array3< T >::operator-= ( const array3< T > & v )

inline

Subtract all the values with the values of an input array.

Parameters

[in] v Input array.

◆ operator-=() [2/2]

template<class T >

void array3< T >::operator-= ( const T & v )

inline

Subtract all the grid values with an input value.

Parameters

[in] v Value to subtract.

◆ operator/=()

template<class T >

void array3< T >::operator/= ( const T & v )

inline

Divide all the grid values with an input value.

Parameters

[in] v Value to divide.

◆ operator=() [1/2]

template<class T >

array3& array3< T >::operator= ( const array3< T > & array )

inline

Deep copy operation for array3.

Parameters

[in] array Reference to an instance of array to copy from.

◆ operator=() [2/2]

template<class T >

void array3< T >::operator= ( const T & v )

inline

Set all the grid values with an input value.

Parameters

[in] v Input value to set.

◆ operator==()

template<class T >

bool array3< T >::operator== ( const array3< T > & v ) const

inline

Return if the grid is same to an input array.

Parameters

[in] v Target array to compare.

Returns: true if the array is the same to the input and false otherwise.

◆ parallel_actives() [1/3]

template<class T >

void array3< T >::parallel_actives ( std::function< void(int i, int j, int k, iterator &it)> func )

inline

Loop over all the active cells in parallel.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ parallel_actives() [2/3]

template<class T >

void array3< T >::parallel_actives ( std::function< void(int i, int j, int k, iterator &it, int thread_index)> func )

inline

Loop over all the active cells in parallel.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ parallel_actives() [3/3]

template<class T >

void array3< T >::parallel_actives ( std::function< void(iterator &it)> func )

inline

Loop over all the active cells in parallel.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ parallel_all() [1/3]

template<class T >

void array3< T >::parallel_all ( std::function< void(int i, int j, int k, iterator &it)> func )

inline

Loop over all the cells in parallel.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ parallel_all() [2/3]

template<class T >

void array3< T >::parallel_all ( std::function< void(int i, int j, int k, iterator &it, int thread_index)> func )

inline

Loop over all the cells in parallel.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ parallel_all() [3/3]

template<class T >

void array3< T >::parallel_all ( std::function< void(iterator &it)> func )

inline

Loop over all the cells in parallel.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ parallel_op() [1/3]

template<class T >

void array3< T >::parallel_op	(	std::function< void(int i, int j, int k, iterator &it)>	func,
		bool	type = `ALL`
	)

inline

Loop over cells in parallel.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ parallel_op() [2/3]

template<class T >

void array3< T >::parallel_op	(	std::function< void(int i, int j, int k, iterator &it, int thread_index)>	func,
		bool	type = `ALL`
	)

inline

Loop over cells in parallel.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ parallel_op() [3/3]

template<class T >

void array3< T >::parallel_op	(	std::function< void(iterator &it)>	func,
		bool	type = `ALL`
	)

inline

Loop over cells in parallel.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ ptr() [1/4]

template<class T >

T* array3< T >::ptr ( const vec3i & pi )

inline

Get the pointer to the value at a position on grid.

Parameters

[in] pi position on grid.

◆ ptr() [2/4]

template<class T >

const T* array3< T >::ptr ( const vec3i & pi ) const

inline

Get the const pointer to the value at a position on grid.

Parameters

[in] pi position on grid.

◆ ptr() [3/4]

template<class T >

T* array3< T >::ptr	(	unsigned	i,
		unsigned	j,
		unsigned	k
	)

inline

Get the pointer to the value at a position on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate

◆ ptr() [4/4]

template<class T >

const T* array3< T >::ptr	(	unsigned	i,
		unsigned	j,
		unsigned	k
	)		const

inline

Get the const pointer to the value at a position on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate

◆ safe_active() [1/2]

template<class T >

bool array3< T >::safe_active ( const vec3i & pi ) const

inline

Get if a position on grid is active. pi can be safely out of the domain.

Parameters

[in] pi position on grid.

Returns: true if active flase if inactive.

◆ safe_active() [2/2]

template<class T >

bool array3< T >::safe_active	(	int	i,
		int	j,
		int	k
	)		const

inline

Get if a position on grid is active. (i,j,k) can be safely out of the domain.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.

Returns: true if active flase if inactive.

◆ send_message()

template<class T >

virtual bool array3< T >::send_message	(	std::string	message,
		void *	ptr
	)

inlineoverridevirtual

Send a message to the core module.

Parameters

[in]	message	Message
[in]	ptr	Pointer to some value.

Returns: true if handled false otherwise.

Reimplemented from messageable.

◆ serial_actives() [1/2]

template<class T >

void array3< T >::serial_actives ( std::function< void(int i, int j, int k, iterator &it)> func )

inline

Loop over all the active cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ serial_actives() [2/2]

template<class T >

void array3< T >::serial_actives ( std::function< void(iterator &it)> func )

inline

Loop over all the active cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ serial_all() [1/2]

template<class T >

void array3< T >::serial_all ( std::function< void(int i, int j, int k, iterator &it)> func )

inline

Loop over all the cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ serial_all() [2/2]

template<class T >

void array3< T >::serial_all ( std::function< void(iterator &it)> func )

inline

Loop over all the cells in serial order.

Parameters

[in] func Function that defines how each grid cell is processed.

◆ serial_op() [1/2]

template<class T >

void array3< T >::serial_op	(	std::function< void(int i, int j, int k, iterator &it)>	func,
		bool	type = `ALL`
	)

inline

Loop over cells in serial order.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ serial_op() [2/2]

template<class T >

void array3< T >::serial_op	(	std::function< void(iterator &it)>	func,
		bool	type = `ALL`
	)

inline

Loop over cells in serial order.

Parameters

[in]	func	Function that defines how each grid cell is processed.
[in]	type	Type of target cells. ACTIVE or ALL.

◆ set() [1/2]

template<class T >

void array3< T >::set	(	const vec3i &	pi,
		const T &	value
	)

inline

Set value on grid.

Parameters

[in]	pi	position on grid
[in]	value	Value to set at the position.

◆ set() [2/2]

template<class T >

void array3< T >::set	(	int	i,
		int	j,
		int	k,
		const T &	value
	)

inline

Set value on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate
[in]	value	Value to set at the position.

◆ set_as_fillable()

template<class T >

void array3< T >::set_as_fillable ( const T & fill_value )

inline

Set the grid as a grid that is fillable by flood fill.

Parameters

[in] fill_value fill_value

◆ set_as_fillable_as()

template<class T >

void array3< T >::set_as_fillable_as ( const array3< T > & array )

inline

Set the grid as fillable as same as an input array.

Parameters

[in] array Input array to mimic the fillable properties.

◆ set_as_levelset()

template<class T >

void array3< T >::set_as_levelset ( double bandwidth_half )

inline

Set the grid as level set.

Parameters

[in] bandwidth_half half bandwidth size of the level set.

◆ set_as_levelset_as()

template<class T >

void array3< T >::set_as_levelset_as ( const array3< T > & array )

inline

Set the grid as level set as same as an input array.

Parameters

[in] array Input array to mimic the level set properties.

◆ set_background_value()

template<class T >

void array3< T >::set_background_value ( const T & value )

inline

Set the background value (alternatively, initial value) of the grid.

Parameters

[in] value New background value

◆ set_core_name()

template<class T >

void array3< T >::set_core_name ( std::string core_name )

inline

Set the core name of module of this grid.

Parameters

[in] Name of the core name.

◆ set_off() [1/2]

template<class T >

void array3< T >::set_off ( const vec3i & pi )

inline

Set a position on grid inactive.

Parameters

[in] pi position on grid

◆ set_off() [2/2]

template<class T >

void array3< T >::set_off	(	int	i,
		int	j,
		int	k
	)

inline

Set a position on grid inactive.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate

◆ set_thread_num()

template<class T >

void array3< T >::set_thread_num ( int number )

inline

Set the number of threads for parallel processing on this grid.

Parameters

[in] number Number of threads.

◆ set_touch_only_actives()

template<class T >

void array3< T >::set_touch_only_actives ( bool touch_only_actives )

inline

Set whether to force grid manipulation only on active cells. If true, operatios such operator+=() only acts on active cells.

Parameters

[in] touch_only_actives Whether to turn this on or off.

◆ set_type()

template<class T >

void array3< T >::set_type ( const type3 & type )

inline

Set the type of this grid.

Parameters

[in] type An instance of type to set.

◆ shape()

template<class T >

shape3 array3< T >::shape ( ) const

inline

Get the shape of the array.

Returns: Shape of the array.

◆ subtract() [1/2]

template<class T >

void array3< T >::subtract	(	const vec3i &	pi,
		const T &	value
	)

inline

Subtract value on grid.

Parameters

[in]	pi	position on grid.
[in]	value	Value to subtract at the position.

◆ subtract() [2/2]

template<class T >

void array3< T >::subtract	(	int	i,
		int	j,
		int	k,
		const T &	value
	)

inline

Subtract value on grid.

Parameters

[in]	i	position on x coordiante.
[in]	j	position on y coordinate.
[in]	k	position on z coordinate
[in]	value	Value to subtract at the position.

◆ swap()

template<class T >

void array3< T >::swap ( array3< T > & rhs )

inline

Swap array.

Parameters

[in] rhs Array to swap.

◆ type()

template<class T >

type3 array3< T >::type ( ) const

inline

Get the type of this grid.

Returns: Type of this grid.

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

include/shiokaze/array/array3.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class array3< T >

Constructor & Destructor Documentation

◆ array3() [1/5]

◆ array3() [2/5]

◆ array3() [3/5]

◆ array3() [4/5]

◆ array3() [5/5]

Member Function Documentation

◆ activate()

◆ activate_as()

◆ activate_as_bit()

◆ activate_inside_as()

◆ active() [1/2]

◆ active() [2/2]

◆ actives()

◆ clear() [1/2]

◆ clear() [2/2]

◆ const_parallel_actives() [1/3]

◆ const_parallel_actives() [2/3]

◆ const_parallel_actives() [3/3]

◆ const_parallel_all() [1/3]

◆ const_parallel_all() [2/3]

◆ const_parallel_all() [3/3]

◆ const_parallel_inside() [1/3]

◆ const_parallel_inside() [2/3]

◆ const_parallel_inside() [3/3]

◆ const_parallel_op() [1/3]

◆ const_parallel_op() [2/3]

◆ const_parallel_op() [3/3]

◆ const_send_message()

◆ const_serial_actives() [1/2]

◆ const_serial_actives() [2/2]

◆ const_serial_all() [1/2]

◆ const_serial_all() [2/2]

◆ const_serial_inside() [1/2]

◆ const_serial_inside() [2/2]

◆ const_serial_op() [1/2]

◆ const_serial_op() [2/2]

◆ copy()

◆ copy_active_as()

◆ count()

◆ devide() [1/2]

◆ devide() [2/2]

◆ dilate() [1/3]

◆ dilate() [2/3]

◆ dilate() [3/3]

◆ erode() [1/3]

◆ erode() [2/3]

◆ erode() [3/3]

◆ filled() [1/2]

◆ filled() [2/2]

◆ fills()

◆ get_core() [1/2]

◆ get_core() [2/2]

◆ get_core_name()

◆ get_parallel_driver() [1/2]

◆ get_parallel_driver() [2/2]

◆ get_thread_num()

◆ increment() [1/2]

◆ increment() [2/2]

◆ initialize()

◆ interruptible_const_serial_actives() [1/2]

◆ interruptible_const_serial_actives() [2/2]

◆ interruptible_const_serial_all() [1/2]

◆ interruptible_const_serial_all() [2/2]

◆ interruptible_const_serial_inside() [1/2]

◆ interruptible_const_serial_inside() [2/2]

◆ interruptible_const_serial_op() [1/2]

◆ interruptible_const_serial_op() [2/2]

◆ interruptible_serial_actives() [1/2]

◆ interruptible_serial_actives() [2/2]

◆ interruptible_serial_all() [1/2]

◆ interruptible_serial_all() [2/2]

◆ interruptible_serial_op() [1/2]

◆ interruptible_serial_op() [2/2]

template<class T>
class array3< T >