Dynamic Neural Field Composer 0.0.0
A C++20 library and interactive application for building and simulating Dynamic Neural Field (DNF) architectures.
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
dnf_composer::element::GaussCoupling Struct Reference

A single sparse Gaussian point-coupling between two spatial locations. More...

#include <gauss_field_coupling.h>

Collaboration diagram for dnf_composer::element::GaussCoupling:

Public Member Functions

 GaussCoupling (const double x_i, const double x_j, const double amplitude, const double width)
 Construct a GaussCoupling. All parameters must be positive.
 
bool operator== (const GaussCoupling &other) const
 
std::string toString () const
 

Public Attributes

double amplitude
 Peak coupling weight.
 
double width
 Gaussian spread (σ) of the coupling.
 
double x_i
 Source location in the input field.
 
double x_j
 Target location in the output field.
 

Detailed Description

A single sparse Gaussian point-coupling between two spatial locations.

Models a localized projection from location x_i in the source field to location x_j in the target field, with a Gaussian spread of width and peak amplitude.

Constructor & Destructor Documentation

◆ GaussCoupling()

dnf_composer::element::GaussCoupling::GaussCoupling ( const double  x_i,
const double  x_j,
const double  amplitude,
const double  width 
)
inline

Construct a GaussCoupling. All parameters must be positive.

Parameters
x_iSource location.
x_jTarget location.
amplitudePeak weight (must be > 0).
widthGaussian σ (must be > 0).

Member Function Documentation

◆ operator==()

bool dnf_composer::element::GaussCoupling::operator== ( const GaussCoupling other) const
inline

◆ toString()

std::string dnf_composer::element::GaussCoupling::toString ( ) const
inline

Member Data Documentation

◆ amplitude

double dnf_composer::element::GaussCoupling::amplitude

Peak coupling weight.

◆ width

double dnf_composer::element::GaussCoupling::width

Gaussian spread (σ) of the coupling.

◆ x_i

double dnf_composer::element::GaussCoupling::x_i

Source location in the input field.

◆ x_j

double dnf_composer::element::GaussCoupling::x_j

Target location in the output field.


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