SPAparameter Class Reference
[Geometric Atoms]

Defines a curve parameter value. More...

#include <param.hxx>

List of all members.

Public Member Functions
void	debug (FILE *fp=debug_file_ptr) const
	Outputs the details of a SPAparameter to the debug file or to the specified file.
	operator double () const
	Returns a double from a parameter.
SPAparameter	operator*= (double rhs)
	Converts a double for multiplication to the right-hand system.
SPAparameter	operator+= (double rhs)
	Converts a double for addition to the right-hand system.
SPAparameter	operator- () const
	Negates a parameter.
SPAparameter	operator-= (double rhs)
	Converts a double for subtraction to the right-hand system.
SPAparameter	operator/= (double rhs)
	Scales a box.
	SPAparameter (double p)
	C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.
	SPAparameter ()
	C++ allocation constructor requests memory for this object but does not populate it.
Friends
double	operator* (int i, SPAparameter const &p)
	Multiplies a SPAparameter and an integer.
double	operator* (SPAparameter const &p, int i)
	Multiplies a SPAparameter and an integer.
double	operator* (double d, SPAparameter const &p)
	Multiplies a SPAparameter and a double.
double	operator* (SPAparameter const &p, double d)
	Multiplies a SPAparameter and a double.
double	operator* (SPAparameter const &p1, SPAparameter const &p2)
	Multiplies two SPAparameters.
double	operator+ (double d, SPAparameter const &p)
	Adds a double and a SPAparameter.
double	operator+ (SPAparameter const &p, double d)
	Adds a SPAparameter and a double.
double	operator+ (SPAparameter const &p1, SPAparameter const &p2)
	Adds two SPAparameters.
double	operator- (double d, SPAparameter const &p)
	Subtracts a SPAparameter from a double.
double	operator- (SPAparameter const &p, double d)
	Subtracts a double from a SPAparameter.
double	operator- (SPAparameter const &p1, SPAparameter const &p2)
	Subtracts the second SPAparameter from the first SPAparameter.
double	operator/ (double d, SPAparameter const &p)
	Divides a double by a SPAparameter.
double	operator/ (SPAparameter const &p, double d)
	Divides a SPAparameter by a double.
double	operator/ (SPAparameter const &p1, SPAparameter const &p2)
	Divides the first SPAparameter by the second SPAparameter.
logical	operator< (double d, SPAparameter const &p)
	Determines if the double is less than the SPAparameter.
logical	operator< (SPAparameter const &p, double d)
	Determines if the SPAparameter is less than the double.
logical	operator< (SPAparameter const &p1, SPAparameter const &p2)
	Determines if the first SPAparameter is less than the second SPAparameter.
logical	operator<= (double d, SPAparameter const &p)
	Determines if the double is less than or equal to the SPAparameter.
logical	operator<= (SPAparameter const &p, double d)
	Determines if the SPAparameter is less than or equal to the double.
logical	operator<= (SPAparameter const &p1, SPAparameter const &p2)
	Determines if the first SPAparameter is less than or equal to the second SPAparameter.
logical	operator> (double d, SPAparameter const &p)
	Determines if the double is greater than the SPAparameter.
logical	operator> (SPAparameter const &p, double d)
	Determines if the SPAparameter is greater than the double.
logical	operator> (SPAparameter const &p1, SPAparameter const &p2)
	Determines if the first SPAparameter is greater than the second SPAparameter.
logical	operator>= (double d, SPAparameter const &p)
	Determines if the double is greater than or equal to the SPAparameter.
logical	operator>= (SPAparameter const &p, double d)
	Determines if the SPAparameter is greater than or equal to the double.
logical	operator>= (SPAparameter const &p1, SPAparameter const &p2)
	Determines if the first SPAparameter is greater than or equal to the second SPAparameter.

---

Detailed Description

Defines a curve parameter value.

Role: This class defines a curve parameter value. It is a floating-point number, but it is declared as a class entity for consistency. Parameter values are invariant under transformations.

See also:

SPApar_pos, SPApar_vec

---

Constructor & Destructor Documentation

SPAparameter::SPAparameter

(

)

[inline]

C++ allocation constructor requests memory for this object but does not populate it.

SPAparameter::SPAparameter

(

double

p

)

[inline]

C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.

Parameters:

p

double.

---

Member Function Documentation

void SPAparameter::debug

(

FILE *

fp = debug_file_ptr

)

const [inline]

Outputs the details of a SPAparameter to the debug file or to the specified file.

Parameters:

fp

file name.

SPAparameter::operator double

(

)

const [inline]

Returns a double from a parameter.

SPAparameter SPAparameter::operator*=

(

double

rhs

)

[inline]

Converts a double for multiplication to the right-hand system.

Parameters:

rhs

double.

SPAparameter SPAparameter::operator+=

(

double

rhs

)

[inline]

Converts a double for addition to the right-hand system.

Parameters:

rhs

double.

SPAparameter SPAparameter::operator-

(

)

const [inline]

Negates a parameter.

SPAparameter SPAparameter::operator-=

(

double

rhs

)

[inline]

Converts a double for subtraction to the right-hand system.

Parameters:

rhs

double.

SPAparameter SPAparameter::operator/=

(

double

rhs

)

[inline]

Scales a box.

Parameters:

rhs

double.

---

Friends And Related Function Documentation

double operator*	(	int	i,
		SPAparameter const &	p
	)			[friend]

Multiplies a SPAparameter and an integer.

Parameters:

	i	integer.
	p	SPAparameter.

double operator*	(	SPAparameter const &	p,
		int	i
	)			[friend]

Multiplies a SPAparameter and an integer.

Parameters:

	p	SPAparameter.
	i	integer.

double operator*	(	double	d,
		SPAparameter const &	p
	)			[friend]

Multiplies a SPAparameter and a double.

Parameters:

	d	double.
	p	SPAparameter.

double operator*	(	SPAparameter const &	p,
		double	d
	)			[friend]

Multiplies a SPAparameter and a double.

Parameters:

	p	SPAparameter.
	d	double.

double operator*	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Multiplies two SPAparameters.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.

double operator+	(	double	d,
		SPAparameter const &	p
	)			[friend]

Adds a double and a SPAparameter.

Parameters:

	d	double.
	p	SPAparameter.

double operator+	(	SPAparameter const &	p,
		double	d
	)			[friend]

Adds a SPAparameter and a double.

Parameters:

	p	SPAparameter.
	d	double.

double operator+	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Adds two SPAparameters.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.

double operator-	(	double	d,
		SPAparameter const &	p
	)			[friend]

Subtracts a SPAparameter from a double.

Parameters:

	d	double.
	p	SPAparameter.

double operator-	(	SPAparameter const &	p,
		double	d
	)			[friend]

Subtracts a double from a SPAparameter.

Parameters:

	p	SPAparameter.
	d	double.

double operator-	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Subtracts the second SPAparameter from the first SPAparameter.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.

double operator/	(	double	d,
		SPAparameter const &	p
	)			[friend]

Divides a double by a SPAparameter.

Parameters:

	d	double.
	p	SPAparameter.

double operator/	(	SPAparameter const &	p,
		double	d
	)			[friend]

Divides a SPAparameter by a double.

Parameters:

	p	SPAparameter.
	d	double.

double operator/	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Divides the first SPAparameter by the second SPAparameter.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.

logical operator<	(	double	d,
		SPAparameter const &	p
	)			[friend]

Determines if the double is less than the SPAparameter.

Parameters:

	d	double.
	p	SPAparameter.

logical operator<	(	SPAparameter const &	p,
		double	d
	)			[friend]

Determines if the SPAparameter is less than the double.

Parameters:

	p	SPAparameter.
	d	double.

logical operator<	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Determines if the first SPAparameter is less than the second SPAparameter.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.

logical operator<=	(	double	d,
		SPAparameter const &	p
	)			[friend]

Determines if the double is less than or equal to the SPAparameter.

Parameters:

	d	double.
	p	SPAparameter.

logical operator<=	(	SPAparameter const &	p,
		double	d
	)			[friend]

Determines if the SPAparameter is less than or equal to the double.

Parameters:

	p	SPAparameter.
	d	double.

logical operator<=	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Determines if the first SPAparameter is less than or equal to the second SPAparameter.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.

logical operator>	(	double	d,
		SPAparameter const &	p
	)			[friend]

Determines if the double is greater than the SPAparameter.

Parameters:

	d	double.
	p	SPAparameter.

logical operator>	(	SPAparameter const &	p,
		double	d
	)			[friend]

Determines if the SPAparameter is greater than the double.

Parameters:

	p	SPAparameter.
	d	double.

logical operator>	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Determines if the first SPAparameter is greater than the second SPAparameter.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.

logical operator>=	(	double	d,
		SPAparameter const &	p
	)			[friend]

Determines if the double is greater than or equal to the SPAparameter.

Parameters:

	d	double.
	p	SPAparameter.

logical operator>=	(	SPAparameter const &	p,
		double	d
	)			[friend]

Determines if the SPAparameter is greater than or equal to the double.

Parameters:

	p	SPAparameter.
	d	double.

logical operator>=	(	SPAparameter const &	p1,
		SPAparameter const &	p2
	)			[friend]

Determines if the first SPAparameter is greater than or equal to the second SPAparameter.

Parameters:

	p1	SPAparameter 1.
	p2	SPAparameter 2.