Regina Calculation Engine

A fast class for storing a ray rooted at the origin whose coordinates are rational. More...
#include <maths/nray.h>
Public Member Functions  
NRay (size_t length)  
Creates a new ray all of whose coordinates are initialised to zero. More...  
NRay (const NVector< NLargeInteger > &cloneMe)  
Creates a new ray that is a clone of the given ray. More...  
void  scaleDown () 
Scales this vector down by the greatest common divisor of all its elements. More...  
void  negate () 
Negates every element of this vector. More...  
size_t  size () const 
Returns the number of elements in the vector. More...  
const NLargeInteger &  operator[] (size_t index) const 
Returns the element at the given index in the vector. More...  
void  setElement (size_t index, const NLargeInteger &value) 
Sets the element at the given index in the vector to the given value. More...  
bool  operator== (const NVector< NLargeInteger > &compare) const 
Determines if this vector is equal to the given vector. More...  
void  operator+= (const NVector< NLargeInteger > &other) 
Adds the given vector to this vector. More...  
void  operator= (const NVector< NLargeInteger > &other) 
Subtracts the given vector from this vector. More...  
void  operator*= (const NLargeInteger &factor) 
Multiplies this vector by the given scalar. More...  
NLargeInteger  operator* (const NVector< NLargeInteger > &other) const 
Calculates the dot product of this vector and the given vector. More...  
NLargeInteger  norm () const 
Returns the norm of this vector. More...  
NLargeInteger  elementSum () const 
Returns the sum of all elements of this vector. More...  
void  addCopies (const NVector< NLargeInteger > &other, const NLargeInteger &multiple) 
Adds the given multiple of the given vector to this vector. More...  
void  subtractCopies (const NVector< NLargeInteger > &other, const NLargeInteger &multiple) 
Subtracts the given multiple of the given vector to this vector. More...  
Static Public Attributes  
static NLargeInteger  zero 
Zero in the underlying number system. More...  
static NLargeInteger  one 
One in the underlying number system. More...  
static NLargeInteger  minusOne 
Negative one in the underlying number system. More...  
Protected Attributes  
NLargeInteger *  elements 
The internal array containing all vector elements. More...  
NLargeInteger *  end 
A pointer just beyond the end of the internal array. More...  
A fast class for storing a ray rooted at the origin whose coordinates are rational.
Such a ray is a halfline beginning at the origin and is represented by an integer point that it passes through. Positive scalar multiples of a ray are considered to represent the same ray.
This class is intended for serious computation, and as a result it has a streamlined implementation with no virtual methods. It can be subclassed, but since there are no virtual methods, type information must generally be known at compile time. Nevertheless, in many respects, different subclasses of NRay can happily interact with one another.

inline 
Creates a new ray all of whose coordinates are initialised to zero.
length  the number of elements in the new vector. 

inline 
Creates a new ray that is a clone of the given ray.
cloneMe  the ray to clone. 

inlineinherited 
Adds the given multiple of the given vector to this vector.
other  the vector a multiple of which will be added to this vector. 
multiple  the multiple of other to be added to this vector. 

inlineinherited 
Returns the sum of all elements of this vector.

inline 
Negates every element of this vector.
This is an optimised implementation that overrides NVector<NLargeInteger>::negate().

inlineinherited 
Returns the norm of this vector.
This is the dot product of the vector with itself.

inlineinherited 
Calculates the dot product of this vector and the given vector.
other  the vector with which this will be multiplied. 

inlineinherited 
Multiplies this vector by the given scalar.
factor  the scalar with which this will be multiplied. 

inlineinherited 
Adds the given vector to this vector.
other  the vector to add to this vector. 

inlineinherited 
Subtracts the given vector from this vector.
other  the vector to subtract from this vector. 

inlineinherited 
Determines if this vector is equal to the given vector.
compare  the vector with which this will be compared. 
true
if and only if the this and the given vector are equal.

inlineinherited 
Returns the element at the given index in the vector.
A constant reference to the element is returned; the element may not be altered.
index
is between 0 and size()1 inclusive.index  the vector index to examine. 
void regina::NRay::scaleDown  (  ) 
Scales this vector down by the greatest common divisor of all its elements.
The resulting vector will be the smallest multiple of the original that maintains integral entries, and these entries will have the same signs as the originals.
This routine thus reduces a ray to its smallest possible representation.
This routine poses no problem for vectors containing infinite elements; such elements are simply ignored and left at infinity.

inlineinherited 
Sets the element at the given index in the vector to the given value.
index
is between 0 and size()1 inclusive.index  the vector index to examine. 
value  the new value to assign to the element. 

inlineinherited 
Returns the number of elements in the vector.

inlineinherited 
Subtracts the given multiple of the given vector to this vector.
other  the vector a multiple of which will be subtracted from this vector. 
multiple  the multiple of other to be subtracted from this vector. 

protectedinherited 
The internal array containing all vector elements.

protectedinherited 
A pointer just beyond the end of the internal array.
The size of the vector can be computed as (end  elements).

staticinherited 
Negative one in the underlying number system.
This would be const
if it weren't for the fact that some compilers don't like this. It should never be modified!

staticinherited 
One in the underlying number system.
This would be const
if it weren't for the fact that some compilers don't like this. It should never be modified!

staticinherited 
Zero in the underlying number system.
This would be const
if it weren't for the fact that some compilers don't like this. It should never be modified!