Skip to main content

Coefficient

Base class: Object

Represents a coefficient in a model that multiplies a interaction. Can be either a real number of a function of a list of lattice coordinates returning a real number.

Factories​

coefficient(const string name, const CoefficientFunction value) -> Coefficient​

Creates a Coefficieint that can be added to a Model.

Parameters​

  • name: The name of the coefficient.
  • value: The value of the coefficient.

coefficient(const string name, real value) -> Coefficient​

Creates a Coefficient that can be added to a Model.

Parameters​

  • name: The name of the coefficient.
  • value: The value of the coefficient.

coefficient(const string name, complex value) -> Coefficient​

Creates a Coefficient that can be added to a Model.

Parameters​

  • name: The name of the coefficient.
  • value: The value of the coefficient.

Constructors​

Coefficient(const Coefficient arg) -> Coefficient​

Copy constructor for a Coefficient.

Parameters​

Symbols​

NameDescription
=Copy constructor for Coefficient.