Represents a power of a generator in a group presentation.
More...
#include <algebra/ngrouppresentation.h>
List of all members.
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:
-
newGen | the number that identifies the generator in the new term. |
newExp | the exponent to which this generator is raised. |
Creates a new term initialised to the given value.
- Parameters:
-
cloneMe | a term whose data will be copied to the new term. |
Member Function Documentation
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.
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:
-
other | the 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.
Makes this term identical to the given term.
- Parameters:
-
cloneMe | the term whose data will be copied to this term. |
- Returns:
- a reference to this term.
Determines whether this and the given term contain identical data.
- Parameters:
-
other | the 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.
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:
-
in | the 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:
-
out | the file to which to write. |
Member Data Documentation
long regina::NGroupExpressionTerm::exponent |
The exponent to which the generator is raised.
unsigned long regina::NGroupExpressionTerm::generator |
The number that identifies the generator in this term.
The documentation for this struct was generated from the following file: