SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.latnetbuilder.weights.ProductWeights Class Reference

Class implementing product weights. More...

Inheritance diagram for umontreal.ssj.latnetbuilder.weights.ProductWeights:
umontreal.ssj.latnetbuilder.weights.WeightsComparable< Integer >

Public Member Functions

 ProductWeights (ArrayList< SingletonWeightComparable< Integer > > weightList)
 Constructor for product weights from a list of SingletonWeightComparable indexed by integers indicating the coordinate.
 ProductWeights ()
 Default constructor.
String toString ()
 Creates a formatted output of the product weights ordered w.r.t.
String toLatNetBuilder ()
 Creates a string formatted for passing it to LatNet Builder.
Public Member Functions inherited from umontreal.ssj.latnetbuilder.weights.WeightsComparable< Integer >
 WeightsComparable (List< SingletonWeightComparable< T > > w)
 Constructs weights from a list of SingletonWeightsComparable.
ArrayList< SingletonWeightComparable< T > > getComparableWeights ()
 Returns the current comparable weights.
void add (SingletonWeightComparable< T > singletonWeight)
 Adds a new comparable weight to the list.
void sort ()
 Sorts the weights w.r.t.

Package Functions

String printBody ()
 Sorts the weights and creates a rudimentary string containing the product weights separated by commas.

Detailed Description

Class implementing product weights.

Each weight is assigned to one coordinate, i.e., \(\gamma_{\mathfrak u} = \prod_{j\in\mathfrak u}\gamma_j\). Thus, the index of each 'SingletonWeightComparable' is given by an integer (starting at 0 for the first coordinate) and corresponds to one specific coordinate.

Author
puchhamf

Definition at line 16 of file ProductWeights.java.

Constructor & Destructor Documentation

◆ ProductWeights() [1/2]

umontreal.ssj.latnetbuilder.weights.ProductWeights.ProductWeights ( ArrayList< SingletonWeightComparable< Integer > > weightList)

Constructor for product weights from a list of SingletonWeightComparable indexed by integers indicating the coordinate.

Parameters
weightListlist of comparable weights to be set as the product weights.

Definition at line 25 of file ProductWeights.java.

◆ ProductWeights() [2/2]

umontreal.ssj.latnetbuilder.weights.ProductWeights.ProductWeights ( )

Default constructor.

Definition at line 32 of file ProductWeights.java.

Member Function Documentation

◆ printBody()

String umontreal.ssj.latnetbuilder.weights.ProductWeights.printBody ( )
package

Sorts the weights and creates a rudimentary string containing the product weights separated by commas.

Missing weights (i.e. a weight for a coordinates which has not been set and lies between two coordinates, whose weights are specified) are filled with 'defaultWeight'.

Returns
a string containing the values of the weights separated by commas.

Definition at line 44 of file ProductWeights.java.

◆ toLatNetBuilder()

String umontreal.ssj.latnetbuilder.weights.ProductWeights.toLatNetBuilder ( )

Creates a string formatted for passing it to LatNet Builder.

Returns
a formatted string that can be processed by LatNet Builder.

Definition at line 86 of file ProductWeights.java.

◆ toString()

String umontreal.ssj.latnetbuilder.weights.ProductWeights.toString ( )

Creates a formatted output of the product weights ordered w.r.t.

to the coordinate they are assigned to. Missing weights (i.e. a weight for a coordinates which has not been set and lies between two coordinates, whose weights are specified) are filled with 'defaultWeight'.

Returns
a formatted output of the product weights.

Definition at line 72 of file ProductWeights.java.


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