SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.latnetbuilder.weights.SingletonWeight< T > Class Template Reference

Implements a single instance of a weight for search-algorithms for quasi-Monte Carlo point sets as, e.g., those implemented in LatNet Builder. More...

Inheritance diagram for umontreal.ssj.latnetbuilder.weights.SingletonWeight< T >:
umontreal.ssj.latnetbuilder.weights.SingletonWeightComparable< T extends Comparable< T > >

Public Member Functions

getIndex ()
 Returns the current 'index'.
void setIndex (T ind)
 Sets the index of the weight to 'ind'.
double getWeight ()
 Returns the current value of the weight.
void setWeight (double w)
 Sets the value of the weight to 'w'.

Package Functions

 SingletonWeight (T ind, double w)
 Constructs a weight with given 'index' and 'weight'.

Detailed Description

Implements a single instance of a weight for search-algorithms for quasi-Monte Carlo point sets as, e.g., those implemented in LatNet Builder.

The template parameter 'T' indicates the data type of the underlying index. Common choices are integers (e.g. the order for OrderDependentWeights) or

CoordinateSet (e.g. the projection for ProjectionDependentWeights), etc.

Author
florian
Parameters
<T>indicates the data type of the index of the weight (e.g. CoordinateSet, Integer,...).

Definition at line 19 of file SingletonWeight.java.

Constructor & Destructor Documentation

◆ SingletonWeight()

umontreal.ssj.latnetbuilder.weights.SingletonWeight< T >.SingletonWeight ( T ind,
double w )
package

Constructs a weight with given 'index' and 'weight'.

Parameters
indthe desired index.
wthe desired value for the weight.

Definition at line 30 of file SingletonWeight.java.

Member Function Documentation

◆ getIndex()

Returns the current 'index'.

Returns
the index of the weight.

Definition at line 40 of file SingletonWeight.java.

◆ getWeight()

Returns the current value of the weight.

Returns
the value of the weight.

Definition at line 58 of file SingletonWeight.java.

◆ setIndex()

Sets the index of the weight to 'ind'.

Parameters
indthe desired value for the 'index'.

Definition at line 49 of file SingletonWeight.java.

◆ setWeight()

void umontreal.ssj.latnetbuilder.weights.SingletonWeight< T >.setWeight ( double w)

Sets the value of the weight to 'w'.

Parameters
wdesired value for the weight

Definition at line 67 of file SingletonWeight.java.


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