SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
PointSetIterator.java
1/*
2 * Interface: PointSetIterator
3 * Description: Iterator over point sets
4 * Environment: Java
5 * Software: SSJ
6 * Copyright (C) 2001 Pierre L'Ecuyer and Universite de Montreal
7 * Organization: DIRO, Universite de Montreal
8 * @author
9 * @since
10 *
11 *
12 * Licensed under the Apache License, Version 2.0 (the "License");
13 * you may not use this file except in compliance with the License.
14 * You may obtain a copy of the License at
15 *
16 * http://www.apache.org/licenses/LICENSE-2.0
17 *
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an "AS IS" BASIS,
20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
23 *
24 */
25package umontreal.ssj.hups;
26
27import umontreal.ssj.rng.RandomStream;
28
71public interface PointSetIterator extends RandomStream {
72
81 public void setCurCoordIndex(int j);
82
86 public void resetCurCoordIndex();
87
94 public int getCurCoordIndex();
95
102 public boolean hasNextCoordinate();
103
114 public double nextCoordinate();
115
126 public void nextCoordinates(double[] p, int d);
127
135 public void setCurPointIndex(int i);
136
140 public void resetCurPointIndex();
141
149 public int resetToNextPoint();
150
157 public int getCurPointIndex();
158
165 public boolean hasNextPoint();
166
192 public int nextPoint(double[] p, int fromDim, int d);
193
197 public int nextPoint(double[] p, int d);
198
199}
This is the interface for iterators that permit one to go through the points of a PointSet and the su...
void resetCurCoordIndex()
Equivalent to setCurCoordIndex(0).
void nextCoordinates(double[] p, int d)
Returns in p the next d coordinates of the current point and advances the current coordinate index by...
int nextPoint(double[] p, int d)
Same as nextPoint(p, 0, d).
int getCurPointIndex()
Returns the index of the current point.
int getCurCoordIndex()
Returns the index of the current coordinate.
boolean hasNextPoint()
Returns true if there is a next point.
void resetCurPointIndex()
Equivalent to setCurPointIndex(0).
void setCurPointIndex(int i)
Resets the current point index to and the current coordinate index to zero.
int nextPoint(double[] p, int fromDim, int d)
Returns in p the next d coordinates of the current point, starting at coordinate fromDim (i....
boolean hasNextCoordinate()
Returns true if the current point has another coordinate.
void setCurCoordIndex(int j)
Sets the current coordinate index to , so that the next calls to nextCoordinate or nextCoordinates wi...
int resetToNextPoint()
Increases the current point index by 1 and returns its new value.
double nextCoordinate()
Returns the current coordinate and advances to the next one.
This interface defines the basic structures to handle multiple streams of uniform (pseudo)random numb...