

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
java.lang.Object org.jscience.mathematics.analysis.PrimitiveMappingNDSampler
public class PrimitiveMappingNDSampler
This class is a wrapper allowing to sample a
PrimitiveMappingND
.
Warning: this class is misleading since it provides SamplerMapping implementation only for mappings of 1 parameter to n parameters, although this is what we expect for use in integration package. Perhaps a better name would be PrimitiveMapping1ToNDSampler.
The sample produced is a regular sample. It can be specified by several means :
The sample points are computed on demand, they are not stored. This allow to use this method for very large sample with little memory overhead. The drawback is that if the same sample points are going to be requested several times, they will be recomputed each time. In this case, the user should consider storing the points by some other means.
PrimitiveMapping
,
Serialized FormConstructor Summary  

PrimitiveMappingNDSampler(PrimitiveMappingND function,
int dim,
double[] range,
double step,
boolean adjustStep)
Constructor. 

PrimitiveMappingNDSampler(PrimitiveMappingND function,
int dim,
double[] range,
int n)
Constructor. 

PrimitiveMappingNDSampler(PrimitiveMappingND function,
int dim,
double begin,
double step,
int n)
Constructor. 
Method Summary  

int 
getSampledDimension()

int 
numInputDimensions()
Get the dimension of the input values of the function. 
int 
numOutputDimensions()
Get the dimension of the output values of the function. 
ValuedPair 
samplePointAt(int index)
Get the abscissa and value of the sample at the specified index. 
int 
size()
Get the number of points in the sample. 
Methods inherited from class java.lang.Object 

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 
Constructor Detail 

public PrimitiveMappingNDSampler(PrimitiveMappingND function, int dim, double begin, double step, int n)
Build a sample from an PrimitiveMapping
. Beware of the
classical offbyone problem ! If you want to have a sample like
this : 0.0, 0.1, 0.2 ..., 1.0, then you should specify step = 0.1
and n = 11 (not n = 10).
dim
 the dimension on which to sample data from (should be between 0 and numInputDimension()  1begin
 beginning of the range (will be the abscissa of the
first point)step
 step between pointsn
 number of pointspublic PrimitiveMappingNDSampler(PrimitiveMappingND function, int dim, double[] range, int n)
PrimitiveMapping
.
dim
 the dimension on which to sample data from (should be between 0 and numInputDimension()  1range
 abscissa range (from range [0]
to
range [1]
)n
 number of pointspublic PrimitiveMappingNDSampler(PrimitiveMappingND function, int dim, double[] range, double step, boolean adjustStep)
PrimitiveMapping
.
dim
 the dimension on which to sample data from (should be between 0 and numInputDimension()  1range
 abscissa range (from range [0]
to
range [1]
)step
 step between pointsadjustStep
 if true, the step is reduced in order to have
the last point of the sample exactly at range [1]
,
if false the last point will be between range [1] 
step
and range [1]
Method Detail 

public int getSampledDimension()
public int size()
SampledMapping
size
in interface SampledMapping
public int numInputDimensions()
numInputDimensions
in interface SampledMapping
public int numOutputDimensions()
numOutputDimensions
in interface SampledMapping
public ValuedPair samplePointAt(int index) throws java.lang.ArrayIndexOutOfBoundsException
SampledMapping
samplePointAt
in interface SampledMapping
index
 index in the sample, should be between 0 and SampledMapping.size()
 1
java.lang.ArrayIndexOutOfBoundsException
 if the index is wrong


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 