SOM internal Neuron struct. More...

#include <SOM.h>

Public Types
typedef utils::SmartPtr< float >	vector_type

Public Member Functions
	Neuron ()
	create a null neuron More...

	Neuron (vector_type gridpos, vector_type prototype, unsigned int griddim, unsigned int datadim)
	create a new neurons with given pointers and dimensions More...

bool	isNull () const
	returns whether this neuron is already initialized (i.e. has valid pointers) More...

Public Attributes
vector_type	gridpos
	grid position vector of dim "griddim" More...

vector_type	prototype
	prototype vector of dim "datadim" More...

unsigned int	griddim
	grid dimension More...

unsigned int	datadim
	prototype dimension More...

void *	meta
	meta-data storage pointer More...

Detailed Description

SOM internal Neuron struct.

The SOM Neuron struct is defined by grid-location vector and prototype vector. In addition, each neuron has a void* meta, that can be used to associate some meta-data with a certain neuron (Note,the pointer meta is not released automatically).

Member Typedef Documentation

◆ vector_type

typedef utils::SmartPtr<float> icl::math::SOM::Neuron::vector_type

Constructor & Destructor Documentation

◆ Neuron() [1/2]

icl::math::SOM::Neuron::Neuron ( )

inline

create a null neuron

◆ Neuron() [2/2]

icl::math::SOM::Neuron::Neuron	(	vector_type	gridpos,
		vector_type	prototype,
		unsigned int	griddim,
		unsigned int	datadim
	)

create a new neurons with given pointers and dimensions

If the deepCopyData flag is set to true, internally new prototype and gridpos pointers are allocated and filled with the given pointer's data. Otherwise, the ownership of the given pointers is passed to the this neuron.

Member Function Documentation

◆ isNull()

bool icl::math::SOM::Neuron::isNull ( ) const

inline

returns whether this neuron is already initialized (i.e. has valid pointers)

Member Data Documentation

◆ datadim

unsigned int icl::math::SOM::Neuron::datadim

prototype dimension

◆ griddim

unsigned int icl::math::SOM::Neuron::griddim

grid dimension

◆ gridpos

vector_type icl::math::SOM::Neuron::gridpos

grid position vector of dim "griddim"

◆ meta

void* icl::math::SOM::Neuron::meta

meta-data storage pointer

◆ prototype

vector_type icl::math::SOM::Neuron::prototype

prototype vector of dim "datadim"

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

/Users/alneuman/vm/icl/ICLMath/src/ICLMath/SOM.h

Public Types

Public Member Functions

Public Attributes