forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkRandomSequence.h
77 lines (64 loc) · 2.27 KB
/
vtkRandomSequence.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*=========================================================================
Program: Visualization Toolkit
Module: vtkRandomSequence.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkRandomSequence
* @brief Generate a sequence of random numbers.
*
* vtkRandomSequence defines the interface of any sequence of random numbers.
*
* At this level of abstraction, there is no assumption about the distribution
* of the numbers or about the quality of the sequence of numbers to be
* statistically independent. There is no assumption about the range of values.
*
* To the question about why a random "sequence" class instead of a random
* "generator" class or to a random "number" class?, see the OOSC book:
* "Object-Oriented Software Construction", 2nd Edition, by Bertrand Meyer.
* chapter 23, "Principles of class design", "Pseudo-random number
* generators: a design exercise", page 754--755.
*/
#ifndef vtkRandomSequence_h
#define vtkRandomSequence_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
class VTKCOMMONCORE_EXPORT vtkRandomSequence : public vtkObject
{
public:
///@{
/**
* Standard methods for type information and printing.
*/
vtkTypeMacro(vtkRandomSequence, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@}
/**
* Initialize the sequence with a seed.
*/
virtual void Initialize(vtkTypeUInt32 seed) = 0;
/**
* Return the current value.
*/
virtual double GetValue() = 0;
/**
* Move to the next number in the random sequence.
*/
virtual void Next() = 0;
/**
* Advance the sequence and return the new value.
*/
double GetNextValue();
protected:
vtkRandomSequence();
~vtkRandomSequence() override;
private:
vtkRandomSequence(const vtkRandomSequence&) = delete;
void operator=(const vtkRandomSequence&) = delete;
};
#endif // #ifndef vtkRandomSequence_h