SPApar_vec Class Reference
[Geometric Atoms]

This class defines a vector (du, dv) in 2D parameter-space. More...

#include <param.hxx>

Inheritance diagram for SPApar_vec:

[legend]

Collaboration diagram for SPApar_vec:

[legend]

List of all members.

Public Member Functions
void	debug (FILE *fp=debug_file_ptr) const
	Outputs details of a parameter vector to the debug file or to the specified file.
logical	is_zero (const double tol=SPAresabs) const
	Returns TRUE if a radius function is zero everywhere, to within a given tolerance; otherwise, it returns FALSE.
double	len () const
	Returns the length of the SPApar_vec.
double	len_sq () const
	Returns (du * du + dv * dv).
SPApar_vec const &	operator*= (double d)
	Multiplies a parameter by a scalar.
SPApar_vec const &	operator+= (SPApar_vec const &v)
	Adds two parameter vectors.
SPApar_vec const &	operator-= (SPApar_vec const &v)
	Performs a binary minus operation.
SPApar_vec const &	operator/= (double d)
	Divides a parameter vector by a scalar value.
	SPApar_vec (SPApar_dir const &d)
	C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.
	SPApar_vec (double uv[2])
	C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.
	SPApar_vec (double u, double v)
	C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.
	SPApar_vec ()
	C++ allocation constructor requests memory for this object but does not populate it.
Public Attributes
SPAparameter	du
	The vector in the u-direction.
SPAparameter	dv
	The vector in the v-direction.
Friends
double	operator% (SPApar_vec const &, SPApar_vec const &)
	Returns the dot product of two parameter vectors.
double	operator* (SPApar_vec const &, SPApar_vec const &)
	Returns the cross product of two parameter vectors.
SPApar_vec	operator* (double d, SPApar_vec const &v)
	Multiplies a parameter vector by a scalar value.
SPApar_vec	operator* (SPApar_vec const &, double)
	Multiplies a parameter vector by a scalar value.
SPApar_vec	operator+ (SPApar_vec const &, SPApar_vec const &)
	Adds the two parameter vectors.
SPApar_vec	operator- (SPApar_vec const &, SPApar_vec const &)
	Performs a binary minus operation.
SPApar_vec	operator- (SPApar_vec const &)
	Performs a unary minus operation on a parameter vector.
SPApar_vec	operator/ (SPApar_vec const &, double)
	Divides a parameter vector by a scalar value.

---

Detailed Description

This class defines a vector (du, dv) in 2D parameter-space.

See also:

SPAparameter

---

Constructor & Destructor Documentation

SPApar_vec::SPApar_vec

(

)

[inline]

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

SPApar_vec::SPApar_vec	(	double	u,
		double	v
	)			[inline]

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

Parameters:

	u	u value.
	v	v value.

SPApar_vec::SPApar_vec

(

double

uv[2]

)

[inline]

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

Parameters:

uv

array of 2 doubles.

---

Member Function Documentation

void SPApar_vec::debug

(

FILE *

fp = debug_file_ptr

)

const

Outputs details of a parameter vector to the debug file or to the specified file.

Parameters:

fp

file name.

logical SPApar_vec::is_zero

(

const double

tol = SPAresabs

)

const

Returns TRUE if a radius function is zero everywhere, to within a given tolerance; otherwise, it returns FALSE.

Parameters:

tol

zero tolerance.

double SPApar_vec::len

(

)

const

Returns the length of the SPApar_vec.

double SPApar_vec::len_sq

(

)

const

Returns (du * du + dv * dv).

SPApar_vec const& SPApar_vec::operator*=

(

double

d

)

Multiplies a parameter by a scalar.

Parameters:

d

double.

SPApar_vec const& SPApar_vec::operator+=

(

SPApar_vec const &

v

)

Adds two parameter vectors.

Parameters:

v

parameter vector.

SPApar_vec const& SPApar_vec::operator-=

(

SPApar_vec const &

v

)

Performs a binary minus operation.

Parameters:

v

parameter vector.

SPApar_vec const& SPApar_vec::operator/=

(

double

d

)

Divides a parameter vector by a scalar value.

Parameters:

d

scalar value.

---

Friends And Related Function Documentation

double operator%	(	SPApar_vec const &	,
		SPApar_vec const &
	)			[friend]

Returns the dot product of two parameter vectors.

Parameters:

	v1	parameter vector.
	v2	parameter vector.

double operator*	(	SPApar_vec const &	,
		SPApar_vec const &
	)			[friend]

Returns the cross product of two parameter vectors.

Parameters:

	v1	parameter vector.
	v2	parameter vector.

SPApar_vec operator*	(	double	d,
		SPApar_vec const &	v
	)			[friend]

Multiplies a parameter vector by a scalar value.

Parameters:

	d	double.
	v	parameter vector.

SPApar_vec operator*	(	SPApar_vec const &	,
		double
	)			[friend]

Multiplies a parameter vector by a scalar value.

Parameters:

	v	parameter vector.
	d	double.

SPApar_vec operator+	(	SPApar_vec const &	,
		SPApar_vec const &
	)			[friend]

Adds the two parameter vectors.

Parameters:

	v1	parameter vector.
	v2	parameter vector.

SPApar_vec operator-	(	SPApar_vec const &	,
		SPApar_vec const &
	)			[friend]

Performs a binary minus operation.

Parameters:

	v1	parameter vector.
	v2	parameter vector.

SPApar_vec operator-

(

SPApar_vec const &

)

[friend]

Performs a unary minus operation on a parameter vector.

Parameters:

v

parameter vector.

SPApar_vec operator/	(	SPApar_vec const &	,
		double
	)			[friend]

Divides a parameter vector by a scalar value.

Parameters:

	v	parameter vector.
	d	double.

---

Member Data Documentation

SPAparameter SPApar_vec::du

The vector in the u-direction.

SPAparameter SPApar_vec::dv

The vector in the v-direction.