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

This class implements so-called product- and order dependent weights (POD weights). More...

Inheritance diagram for umontreal.ssj.latnetbuilder.weights.PODWeights:
umontreal.ssj.latnetbuilder.weights.Weights< T >

Public Member Functions

 PODWeights (ProductWeights pWeights, OrderDependentWeights odWeights)
 Constructs an instance of POD weights.
 PODWeights (ProductWeights pWeights)
 Constructor for given productWeights and orderDependentWeights is constructed by the default constructor for OrderDependentWeights.
 PODWeights (OrderDependentWeights odWeights)
 Constructor for given orderDependentWeights and productWeights is constructed by the default constructor for ProductWeights.
 PODWeights ()
 Default constructor.
ProductWeights getProductWeights ()
 Getter for the product weight-component.
void setProductWeights (ProductWeights productWeights)
 Setter for the product weight-component.
OrderDependentWeights getOrderDependentWeights ()
 Getter for the order dependent weight-component.
void setOrderDependentWeights (OrderDependentWeights orderDependentWeights)
 Setter for the order dependent weight-component.
void addOrderDependentWeight (SingletonWeightComparable< Integer > weight)
 Adds the order dependent weight 'weight'.
void addOrderDependentWeight (int ord, double weight)
 Adds an order dependent weight by passing the order and the value of the weight.
void addProductWeight (SingletonWeightComparable< Integer > weight)
 Adds the product weight 'weight'.
void addProductWeight (int index, double weight)
 Adds a product weight by passing the coordinate index and the value of the weight.
String toString ()
 Basic formatted string-output.
String toLatNetBuilder ()
 Provides a String that can be interpreted by the command line interface of LatNetBuilder.
Public Member Functions inherited from umontreal.ssj.latnetbuilder.weights.Weights< T >
 Weights (List< SingletonWeight< T > > w)
 Constructs weights from a list of SingletonWeights.
 Weights ()
 Initializes an empty list of weights.
ArrayList< SingletonWeight< T > > getWeights ()
 Returns the current weights as a list.
void setDefaultWeight (double dWeight)
 Sets 'dWeight' as the current 'defaultWeight'.
double getDefaultWeight ()
 Returns the current 'defaultWeight'.
void add (SingletonWeight< T > singletonWeight)
 Adds a new weight.
void add (T index, double weight)
 Adds a new weight with index 'index' and weight 'weight' or overwrites it, if the index already exists in the list.

Package Attributes

ProductWeights productWeights
 The product weight-component.
OrderDependentWeights orderDependentWeights
 The order dependent weight-component.

Additional Inherited Members

Protected Attributes inherited from umontreal.ssj.latnetbuilder.weights.Weights< T >
double defaultWeight = 0.0
 Weight to be used for indices that were not explicitly set.

Detailed Description

This class implements so-called product- and order dependent weights (POD weights).

As the name suggests, POD weights are composed of OrderDependentWeights and ProductWeights via \(\gamma_{\mathfrak u} = \Gamma_{|\mathfrak u|}\prod_{j\in\mathfrak u}\gamma_j\).

Author
florian

Definition at line 19 of file PODWeights.java.

Constructor & Destructor Documentation

◆ PODWeights() [1/4]

umontreal.ssj.latnetbuilder.weights.PODWeights.PODWeights ( ProductWeights pWeights,
OrderDependentWeights odWeights )

Constructs an instance of POD weights.

Parameters
pWeightsThe product weight-component.
odWeightsThe order dependent weight-component.

Definition at line 36 of file PODWeights.java.

◆ PODWeights() [2/4]

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

Constructor for given productWeights and orderDependentWeights is constructed by the default constructor for OrderDependentWeights.

Parameters
pWeightsThe product weight-component.

Definition at line 47 of file PODWeights.java.

◆ PODWeights() [3/4]

umontreal.ssj.latnetbuilder.weights.PODWeights.PODWeights ( OrderDependentWeights odWeights)

Constructor for given orderDependentWeights and productWeights is constructed by the default constructor for ProductWeights.

Parameters
odWeightsThe order dependent weight-component.

Definition at line 58 of file PODWeights.java.

◆ PODWeights() [4/4]

umontreal.ssj.latnetbuilder.weights.PODWeights.PODWeights ( )

Default constructor.

Definition at line 66 of file PODWeights.java.

Member Function Documentation

◆ addOrderDependentWeight() [1/2]

void umontreal.ssj.latnetbuilder.weights.PODWeights.addOrderDependentWeight ( int ord,
double weight )

Adds an order dependent weight by passing the order and the value of the weight.

Parameters
ordThe order of the weight to be added.
weightThe value of the weight to be added.

Definition at line 119 of file PODWeights.java.

◆ addOrderDependentWeight() [2/2]

void umontreal.ssj.latnetbuilder.weights.PODWeights.addOrderDependentWeight ( SingletonWeightComparable< Integer > weight)

Adds the order dependent weight 'weight'.

Parameters
weightOrder dependent weight to be added.

Definition at line 108 of file PODWeights.java.

◆ addProductWeight() [1/2]

void umontreal.ssj.latnetbuilder.weights.PODWeights.addProductWeight ( int index,
double weight )

Adds a product weight by passing the coordinate index and the value of the weight.

Parameters
indexThe coordinate index of the weight to be added.
weightThe value of the weight to be added.

Definition at line 139 of file PODWeights.java.

◆ addProductWeight() [2/2]

void umontreal.ssj.latnetbuilder.weights.PODWeights.addProductWeight ( SingletonWeightComparable< Integer > weight)

Adds the product weight 'weight'.

Parameters
weightProduct weight to be added.

Definition at line 128 of file PODWeights.java.

◆ getOrderDependentWeights()

OrderDependentWeights umontreal.ssj.latnetbuilder.weights.PODWeights.getOrderDependentWeights ( )

Getter for the order dependent weight-component.

Returns
The order dependent weight-component.

Definition at line 92 of file PODWeights.java.

◆ getProductWeights()

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

Getter for the product weight-component.

Returns
The product weight-component.

Definition at line 76 of file PODWeights.java.

◆ setOrderDependentWeights()

void umontreal.ssj.latnetbuilder.weights.PODWeights.setOrderDependentWeights ( OrderDependentWeights orderDependentWeights)

Setter for the order dependent weight-component.

Definition at line 99 of file PODWeights.java.

◆ setProductWeights()

void umontreal.ssj.latnetbuilder.weights.PODWeights.setProductWeights ( ProductWeights productWeights)

Setter for the product weight-component.

Definition at line 83 of file PODWeights.java.

◆ toLatNetBuilder()

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

Provides a String that can be interpreted by the command line interface of LatNetBuilder.

Returns
String for LatNetBuilder.

Reimplemented from umontreal.ssj.latnetbuilder.weights.Weights< T >.

Definition at line 153 of file PODWeights.java.

◆ toString()

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

Basic formatted string-output.

Reimplemented from umontreal.ssj.latnetbuilder.weights.Weights< T >.

Definition at line 144 of file PODWeights.java.

Member Data Documentation

◆ orderDependentWeights

OrderDependentWeights umontreal.ssj.latnetbuilder.weights.PODWeights.orderDependentWeights
package

The order dependent weight-component.

Definition at line 28 of file PODWeights.java.

◆ productWeights

ProductWeights umontreal.ssj.latnetbuilder.weights.PODWeights.productWeights
package

The product weight-component.

Definition at line 24 of file PODWeights.java.

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