q1471341.mp1074.integration.lattice
Class LatticeRule

java.lang.Object
  extended byq1471341.mp1074.integration.lattice.LatticeRule
Direct Known Subclasses:
EmbeddedCopyRule, GoodLatticePointsRule

public abstract class LatticeRule
extends java.lang.Object

The abstract root class of the lattice rule hierarchy. The subclasses implement specific lattice rules for numerical integration.

Author:
Ulrich Telle

Constructor Summary
LatticeRule()
          Constructs an instance of a lattice rule.
 
Method Summary
abstract  double evaluate(int s, int m, int[] z, Integrand f)
          Performs evaluation of the lattice rule.
 double getEstimatedError()
           
 int getNCopy()
           
 int getNumberOfIntegrandEvaluations()
           
 Periodizer getPeriodizer()
           
 boolean getUseErrorEstimation()
           
 void setPeriodizer(Periodizer periodizer)
           
 void setUseErrorEstimation(boolean useErrorEstimation)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LatticeRule

public LatticeRule()
Constructs an instance of a lattice rule. Error estimation and periodizing of the integrand function is turned off by default.

Method Detail

evaluate

public abstract double evaluate(int s,
                                int m,
                                int[] z,
                                Integrand f)
Performs evaluation of the lattice rule.

Parameters:
s - dimension of the integrand domain
m - order of the lattice rule
z - lattice rule generator vector
f - integrand function
Returns:
result of integration

setUseErrorEstimation

public void setUseErrorEstimation(boolean useErrorEstimation)
Parameters:
useErrorEstimation - The error estimation flag to set.

getUseErrorEstimation

public boolean getUseErrorEstimation()
Returns:
Returns the flag whether error estimation should be performed.

getEstimatedError

public double getEstimatedError()
Returns:
Returns the estimated error of integral value.

getNumberOfIntegrandEvaluations

public int getNumberOfIntegrandEvaluations()
Returns:
Returns the number of integrand evaluations.

getPeriodizer

public Periodizer getPeriodizer()
Returns:
Returns the periodizer.

setPeriodizer

public void setPeriodizer(Periodizer periodizer)
Parameters:
periodizer - The periodizer to set.

getNCopy

public int getNCopy()
Returns:
Returns the nCopy.