member functions '{save|restore}_seed' changed to '{save|restore}_state'.

This commit is contained in:
Sven Schönherr 1999-02-10 14:23:21 +00:00
parent 5dbecd4ef1
commit f2c4f840b5
2 changed files with 30 additions and 30 deletions

View File

@ -29,7 +29,7 @@ were extracted from the other streams.
It can be very useful, e.g.\ for debugging, to reproduce a sequence of
random numbers. This can be done by either initialising
deterministically or using the seed functions as described below.
deterministically or using the state functions as described below.
\ccInclude{CGAL/Random.h}
@ -44,7 +44,7 @@ deterministically or using the seed functions as described below.
\ccTypes
\ccUnchecked
\ccNestedType{Seed}{Seed type.}
\ccNestedType{State}{State type.}
% -----------------------------------------------------------------------------
\ccCreation
@ -53,16 +53,16 @@ deterministically or using the seed functions as described below.
\ccConstructor{ CGAL_Random( );}{
introduces a variable \ccVar\ of type \ccClassTemplateName.}
\ccConstructor{ CGAL_Random( Seed seed);}{
\ccConstructor{ CGAL_Random( long seed);}{
introduces a variable \ccVar\ of type \ccClassTemplateName\
and initializes its internal seed with \ccc{seed}.}
\ccConstructor{ CGAL_Random( long init);}{
introduces a variable \ccVar\ of type \ccClassTemplateName\
and initializes its internal seed using \ccc{init}. Equal
values for \ccc{init} result in equal sequences of random
and initializes its internal state using \ccc{seed}. Equal
values for \ccc{seed} result in equal sequences of random
numbers.}
\ccConstructor{ CGAL_Random( State state);}{
introduces a variable \ccVar\ of type \ccClassTemplateName\
and initializes its internal state with \ccc{state}.}
% -----------------------------------------------------------------------------
\ccOperations
@ -82,20 +82,20 @@ deterministically or using the seed functions as described below.
returns \ccVar\ccc{.get_int( 0, upper)}.}
% -----------------------------------------------------------------------------
\ccHeading{Seed Functions}
\ccHeading{State Functions}
\ccMemberFunction{ void save_seed( Seed& seed) const;}{
saves the current internal seed in \ccc{seed}.}
\ccMemberFunction{ void save_state( State& state) const;}{
saves the current internal state in \ccc{state}.}
\ccMemberFunction{ void restore_seed( Seed const& seed);}{
restores the internal seed from \ccc{seed}.}
\ccMemberFunction{ void restore_state( State const& state);}{
restores the internal state from \ccc{state}.}
% -----------------------------------------------------------------------------
\ccHeading{Equality Test}
\ccMemberFunction{ bool operator == ( CGAL_Random const& random2) const;}{
returns \ccc{true}, iff \ccVar\ and \ccc{random2} have equal
internal seeds.}
internal states.}
% -----------------------------------------------------------------------------
\ccImplementation

View File

@ -29,7 +29,7 @@ were extracted from the other streams.
It can be very useful, e.g.\ for debugging, to reproduce a sequence of
random numbers. This can be done by either initialising
deterministically or using the seed functions as described below.
deterministically or using the state functions as described below.
\ccInclude{CGAL/Random.h}
@ -44,7 +44,7 @@ deterministically or using the seed functions as described below.
\ccTypes
\ccUnchecked
\ccNestedType{Seed}{Seed type.}
\ccNestedType{State}{State type.}
% -----------------------------------------------------------------------------
\ccCreation
@ -53,16 +53,16 @@ deterministically or using the seed functions as described below.
\ccConstructor{ CGAL_Random( );}{
introduces a variable \ccVar\ of type \ccClassTemplateName.}
\ccConstructor{ CGAL_Random( Seed seed);}{
\ccConstructor{ CGAL_Random( long seed);}{
introduces a variable \ccVar\ of type \ccClassTemplateName\
and initializes its internal seed with \ccc{seed}.}
\ccConstructor{ CGAL_Random( long init);}{
introduces a variable \ccVar\ of type \ccClassTemplateName\
and initializes its internal seed using \ccc{init}. Equal
values for \ccc{init} result in equal sequences of random
and initializes its internal state using \ccc{seed}. Equal
values for \ccc{seed} result in equal sequences of random
numbers.}
\ccConstructor{ CGAL_Random( State state);}{
introduces a variable \ccVar\ of type \ccClassTemplateName\
and initializes its internal state with \ccc{state}.}
% -----------------------------------------------------------------------------
\ccOperations
@ -82,20 +82,20 @@ deterministically or using the seed functions as described below.
returns \ccVar\ccc{.get_int( 0, upper)}.}
% -----------------------------------------------------------------------------
\ccHeading{Seed Functions}
\ccHeading{State Functions}
\ccMemberFunction{ void save_seed( Seed& seed) const;}{
saves the current internal seed in \ccc{seed}.}
\ccMemberFunction{ void save_state( State& state) const;}{
saves the current internal state in \ccc{state}.}
\ccMemberFunction{ void restore_seed( Seed const& seed);}{
restores the internal seed from \ccc{seed}.}
\ccMemberFunction{ void restore_state( State const& state);}{
restores the internal state from \ccc{state}.}
% -----------------------------------------------------------------------------
\ccHeading{Equality Test}
\ccMemberFunction{ bool operator == ( CGAL_Random const& random2) const;}{
returns \ccc{true}, iff \ccVar\ and \ccc{random2} have equal
internal seeds.}
internal states.}
% -----------------------------------------------------------------------------
\ccImplementation