Regina Calculation Engine
Public Member Functions | Static Public Member Functions | Public Attributes
regina::NGroupExpressionTerm Struct Reference

Represents a power of a generator in a group presentation. More...

#include <ngrouppresentation.h>

List of all members.

Public Member Functions

 NGroupExpressionTerm ()
 Creates a new uninitialised term.
 NGroupExpressionTerm (unsigned long newGen, long newExp)
 Creates a new term initialised to the given value.
 NGroupExpressionTerm (const NGroupExpressionTerm &cloneMe)
 Creates a new term initialised to the given value.
NGroupExpressionTermoperator= (const NGroupExpressionTerm &cloneMe)
 Makes this term identical to the given term.
bool operator== (const NGroupExpressionTerm &other) const
 Determines whether this and the given term contain identical data.
NGroupExpressionTerm inverse () const
 Returns the inverse of this term.
bool operator+= (const NGroupExpressionTerm &other)
 Attempts to merge this term with the given term.
void writeToFile (NFile &out) const
 Writes this term to the given old-style binary file.

Static Public Member Functions

static NGroupExpressionTerm readFromFile (NFile &in)
 Reads a term from the given old-style binary file.

Public Attributes

unsigned long generator
 The number that identifies the generator in this term.
long exponent
 The exponent to which the generator is raised.

Detailed Description

Represents a power of a generator in a group presentation.


Constructor & Destructor Documentation

regina::NGroupExpressionTerm::NGroupExpressionTerm ( ) [inline]

Creates a new uninitialised term.

regina::NGroupExpressionTerm::NGroupExpressionTerm ( unsigned long  newGen,
long  newExp 
) [inline]

Creates a new term initialised to the given value.

Parameters:
newGenthe number that identifies the generator in the new term.
newExpthe exponent to which this generator is raised.
regina::NGroupExpressionTerm::NGroupExpressionTerm ( const NGroupExpressionTerm cloneMe) [inline]

Creates a new term initialised to the given value.

Parameters:
cloneMea term whose data will be copied to the new term.

Member Function Documentation

NGroupExpressionTerm regina::NGroupExpressionTerm::inverse ( ) const [inline]

Returns the inverse of this term.

The inverse has the same generator but a negated exponent.

Note that this term will remain unchanged.

Returns:
the inverse of this term.
bool regina::NGroupExpressionTerm::operator+= ( const NGroupExpressionTerm other) [inline]

Attempts to merge this term with the given term.

If both terms have the same generator, the two exponents will be added and stored in this term. If the generators are different, this routine will do nothing.

Note that this term might be changed but the given term will remain unchanged.

Parameters:
otherthe term to merge with this term.
Returns:
true if the two terms were merged into this term, or false if the two terms have different generators.
NGroupExpressionTerm & regina::NGroupExpressionTerm::operator= ( const NGroupExpressionTerm cloneMe) [inline]

Makes this term identical to the given term.

Parameters:
cloneMethe term whose data will be copied to this term.
Returns:
a reference to this term.
bool regina::NGroupExpressionTerm::operator== ( const NGroupExpressionTerm other) const [inline]

Determines whether this and the given term contain identical data.

Parameters:
otherthe term with which this term will be compared.
Returns:
true if and only if this and the given term have both the same generator and exponent.
static NGroupExpressionTerm regina::NGroupExpressionTerm::readFromFile ( NFile in) [static]

Reads a term from the given old-style binary file.

Deprecated:
For the preferred way of reading group presentations from file, see class NXMLGroupPresentationReader instead.
Precondition:
The given file is currently opened for reading.
Python:
Not present.
Parameters:
inthe file from which to read.
Returns:
the term read from the given file.
void regina::NGroupExpressionTerm::writeToFile ( NFile out) const

Writes this term to the given old-style binary file.

Deprecated:
For the preferred way to write data to file, see NGroupExpression::writeXMLData() instead.
Precondition:
The given file is currently opened for writing.
Python:
Not present.
Parameters:
outthe file to which to write.

Member Data Documentation

The exponent to which the generator is raised.

The number that identifies the generator in this term.


The documentation for this struct was generated from the following file:

Copyright © 1999-2009, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).