Sparse Gaussian field coupling with a fixed, user-defined projection. More...

#include <gauss_field_coupling.h>

Inheritance diagram for dnf_composer::element::GaussFieldCoupling:

Collaboration diagram for dnf_composer::element::GaussFieldCoupling:

Public Member Functions
void	addCoupling (const GaussCoupling &coupling)
	Append a new point-coupling at runtime.

void	changeDimensions (const ElementDimensions &newDimensions) override
	Resize the output field dimensions and rebuild the weight matrix. Preserves input field dimensions and clears weights. Connections are not removed — call removeInputs()/removeOutputs() first if needed.

void	changeInputDimensions (const ElementDimensions &newInputDimensions)
	Resize the input field dimensions and rebuild the weight matrix. Preserves output field dimensions and clears weights. Connections are not removed — call removeInputs()/removeOutputs() first if needed.

std::shared_ptr< Element >	clone () const override

	GaussFieldCoupling (const ElementCommonParameters &elementCommonParameters, const GaussFieldCouplingParameters &gfc_parameters)
	Construct a GaussFieldCoupling.

ElementDimensions	getInputFieldDimensions () const

GaussFieldCouplingParameters	getParameters () const

void	init () override
	Initialize the element (called once before the simulation loop).

void	setParameters (const GaussFieldCouplingParameters &gfc_parameters)

void	step (double t, double deltaT) override
	Advance the element by one time step.

std::string	toString () const override

Public Member Functions inherited from dnf_composer::element::Element
virtual void	addInput (const std::shared_ptr< Element > &inputElement, const std::string &inputComponent="output")
	Register `inputElement` as an upstream source for this element.

void	buildInputCache ()
	Cache raw pointers to input component data. Call after all element init()s complete.

void	close ()

	Element (const ElementCommonParameters &parameters)
	Construct an element with the given common parameters.

std::vector< double >	getComponent (const std::string &componentName)
	Return a copy of the named component vector.

std::vector< std::string >	getComponentList () const

std::vector< double > *	getComponentPtr (const std::string &componentName)

const std::unordered_map< std::string, std::vector< double > > *	getComponents () const
	Return a read-only pointer to the full components map.

ElementCommonParameters	getElementCommonParameters () const

std::vector< std::shared_ptr< Element > >	getInputs ()

std::unordered_map< std::shared_ptr< Element >, std::string >	getInputsAndComponents ()
	Return all inputs mapped to the component name they expose.

ElementLabel	getLabel () const

int	getMaxSpatialDimension () const

std::vector< std::shared_ptr< Element > >	getOutputs ()

int	getSize () const
	Return the number of spatial samples (size = round(x_max / d_x)).

double	getStepSize () const
	Return the spatial resolution (d_x).

int	getUniqueIdentifier () const

std::string	getUniqueName () const

bool	hasInput () const

bool	hasInput (const std::string &inputElementName, const std::string &inputComponent)

bool	hasInput (int inputElementId, const std::string &inputComponent)

bool	hasOutput () const

bool	hasOutput (const std::string &outputElementName, const std::string &outputComponent)

bool	hasOutput (int outputElementId, const std::string &outputComponent)

void	print () const

void	removeInput (const std::string &inputElementId)

void	removeInput (int uniqueId)

void	removeInputs ()

void	removeOutput (const std::string &outputElementId)
	Deregister this element as an input of `outputElementId`.

void	removeOutput (int uniqueId)
	Deregister this element as an input of the element with `uniqueId`.

void	removeOutputs ()

void	setUniqueName (const std::string &name)

void	updateInput ()
	Pull data from all registered input elements into this element's components.

virtual	~Element ()=default

Additional Inherited Members
Protected Attributes inherited from dnf_composer::element::Element
ElementCommonParameters	commonParameters
	Name, label, and spatial dimensions.

std::unordered_map< std::string, std::vector< double > >	components
	Named data arrays (e.g. "output").

std::unordered_map< std::shared_ptr< Element >, std::string >	inputs
	Upstream elements and the component they expose.

std::unordered_map< std::shared_ptr< Element >, std::string >	outputs
	Downstream elements that read this element's output.

Detailed Description

Sparse Gaussian field coupling with a fixed, user-defined projection.

Unlike FieldCoupling (which learns a full weight matrix), GaussFieldCoupling uses an explicit list of GaussCoupling descriptors. Each descriptor projects activity from a source location x_i to a target location x_j with a Gaussian spread. This is useful for hand-crafted or evolution-derived projections where the exact connectivity is known in advance.

Constructor & Destructor Documentation

◆ GaussFieldCoupling()

dnf_composer::element::GaussFieldCoupling::GaussFieldCoupling	(	const ElementCommonParameters &	elementCommonParameters,
		const GaussFieldCouplingParameters &	gfc_parameters
	)

Construct a GaussFieldCoupling.

Parameters

elementCommonParameters	Name, label, and output field dimensions.
gfc_parameters	Coupling parameters (source dims + coupling list).

Member Function Documentation

◆ addCoupling()

void dnf_composer::element::GaussFieldCoupling::addCoupling ( const GaussCoupling & coupling )

Append a new point-coupling at runtime.

Parameters

coupling The GaussCoupling to add.

◆ changeDimensions()

void dnf_composer::element::GaussFieldCoupling::changeDimensions ( const ElementDimensions & newDimensions )

overridevirtual

Resize the output field dimensions and rebuild the weight matrix. Preserves input field dimensions and clears weights. Connections are not removed — call removeInputs()/removeOutputs() first if needed.

Reimplemented from dnf_composer::element::Element.

Here is the call graph for this function:

◆ changeInputDimensions()

void dnf_composer::element::GaussFieldCoupling::changeInputDimensions ( const ElementDimensions & newInputDimensions )

Resize the input field dimensions and rebuild the weight matrix. Preserves output field dimensions and clears weights. Connections are not removed — call removeInputs()/removeOutputs() first if needed.

Here is the call graph for this function:

◆ clone()

std::shared_ptr< Element > dnf_composer::element::GaussFieldCoupling::clone ( ) const

overridevirtual

Implements dnf_composer::element::Element.

◆ getInputFieldDimensions()

ElementDimensions dnf_composer::element::GaussFieldCoupling::getInputFieldDimensions ( ) const

◆ getParameters()

GaussFieldCouplingParameters dnf_composer::element::GaussFieldCoupling::getParameters ( ) const

◆ init()

void dnf_composer::element::GaussFieldCoupling::init ( )

overridevirtual

Initialize the element (called once before the simulation loop).

Implements dnf_composer::element::Element.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParameters()

void dnf_composer::element::GaussFieldCoupling::setParameters ( const GaussFieldCouplingParameters & gfc_parameters )

Here is the call graph for this function:

◆ step()

void dnf_composer::element::GaussFieldCoupling::step	(	double	t,
		double	deltaT
	)

overridevirtual

Advance the element by one time step.

Parameters

t	Current simulation time.
deltaT	Integration step size.

Implements dnf_composer::element::Element.

Here is the call graph for this function:

◆ toString()

std::string dnf_composer::element::GaussFieldCoupling::toString ( ) const

overridevirtual

Implements dnf_composer::element::Element.

Here is the call graph for this function:

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

include/elements/gauss_field_coupling.h
src/elements/gauss_field_coupling.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GaussFieldCoupling()

Member Function Documentation

◆ addCoupling()

◆ changeDimensions()

◆ changeInputDimensions()

◆ clone()

◆ getInputFieldDimensions()

◆ getParameters()

◆ init()

◆ setParameters()

◆ step()

◆ toString()