Global settings¶

Various global settings such as tolerances, …

AtlasEntries¶

replab.globals.atlasEntries(newValue)¶

Library of groups and character tables

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored atlas entries
Return type: cell(1,*) of replab.AtlasEntry

AtlasMaximalOrder¶

replab.globals.atlasMaximalOrder(newValue)¶

Maximum order for which a user-defined group is automatically recognized

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

AutoConjugacyClassesMaximalOrder¶

replab.globals.autoConjugacyClassesMaximalOrder(newValue)¶

Maximum order for which algorithms depending on conjugacy classes are automatically used

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

AutoInstall¶

replab.globals.autoInstall(newValue)¶: Get/set whether dependencies should be automatically downloaded and installed

BsgsFailureProbability¶

replab.globals.bsgsFailureProbability(newValue)¶

CharacterTableSymmetricGroupIrrep¶

replab.globals.characterTableSymmetricGroupIrrep(newValue)¶

Default form of irreducible representations of the symmetric group

Parameters: newValue ({‘specht’, ‘seminormal’, ‘orthogonal’} or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

CodeBase¶

replab.globals.codeBase(newValue)¶

Get/set the parsed code used in the help system

If called without argument, returns the stored value.

The call with one argument changes the stored value; it should only be called as part of replab_init.

The stored value survives clear all as this function is locked.

Call replab.globals.codeBase([]) or help -clear to clear it.

Parameters: newValue (function_handle, optional) – Sets the stored value
Returns: Stored function handle
Return type: function_handle

ConsoleUseHTML¶

replab.globals.consoleUseHTML(newValue)¶

Returns whether the console output accepts a subset of the HTML language

The subset is the one parsed by MATLAB when using the GUI; it mostly accepts strong (for bold text) and a href= (for links) HTML tags.

CosetEnumerationMethod¶

replab.globals.cosetEnumerationMethod(newValue)¶

Method to use for coset enumeration

RepLAB can either use ‘R’elator-based or ‘C’oset-table based enumeration, see Chapter 5 of Holt, Derek, Handbook of Computational Group Theory, Chapman & Hall/CRC, 2004, pp. 149–198

Parameters: newValue ({‘R’, ‘C’} or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

DefaultHelpFunction¶

replab.globals.defaultHelpFunction(newValue)¶

Get/set the function handle corresponding to the default help function (one input/output variant)

If called without argument, returns the stored value.

The call with one argument changes the stored value; it should only be called as part of replab_init.

The stored value survives clear all as this function is locked.

Parameters: newValue (function_handle, optional) – Sets the stored value
Returns: Stored function handle
Return type: function_handle

DoubleEigTol¶

replab.globals.doubleEigTol(newValue)¶

DoubleSdpTol¶

replab.globals.doubleSdpTol(newValue)¶

FactorizationOrderCutoff¶

replab.globals.factorizationOrderCutoff(newValue)¶

Maximum order under which use orbit enumeration to factorize group elements in generator words

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

FastChainDomainSize¶

replab.globals.fastChainDomainSize(newValue)¶

Maximum domainSize for fast chain construction

See replab.PermutationGroup.partialChain

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

FastChainOrder¶

replab.globals.fastChainOrder(newValue)¶

Maximum order for fast chain construction

See replab.PermutationGroup.partialChain

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

FormatCharacterTable¶

replab.globals.formatCharacterTable(newValue)¶

Maximum order under which use orbit enumeration to factorize group elements in generator words

Parameters: newValue ({‘gap’, ‘plain’, or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

GapBinaryPath¶

replab.globals.gapBinaryPath(newValue)¶

Get/set the path to the GAP System binary

(On a Linux system, this is the path to the gap.sh script).

Parameters: newValue (charstring or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

MatrixGroupTol¶

replab.globals.matrixGroupTol(newValue)¶

Tolerance for equality tests in continuous matrix groups

See replab.ClassicalCompactGroup.

Parameters: newValue (nonnegative double or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: double

MaxCosets¶

replab.globals.maxCosets(newValue)¶

Maximum number of cosets to enumerate during the Todd-Coxeter algorithm

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

MaxDeductions¶

replab.globals.maxDeductions(newValue)¶

Maximum number of deductions to store during the Todd-Coxeter algorithm

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

MorphismNChecks¶

replab.globals.morphismNChecks(newValue)¶

Default number of randomized checks to perform when constructing morphisms

If equal to inf and for finite groups, it performs a deterministic check.

See for example replab.FiniteGroup.morphismByImages

Parameters: newValue (integer or inf or [], optional) – Value to be stored if provided
Returns: Stored integer value
Return type: integer

NextUniqueId¶

replab.globals.nextUniqueId()¶

Returns a unique integer

Returns: Unique integer to be used as ID
Return type: integer

RandomizedSchreierSimsTries¶

replab.globals.randomizedSchreierSimsTries(newValue)¶

Gets/sets the number of sifted elements before the BSGS chain is declared complete

This is the number of successive failed attempts to generate a new strong generator before deciding the chain is complete in the randomized Schreier-Sims algorithm; the probability of failure is then less than 1/2^value.

Parameters: newValue (integer, optional) – New value
Returns: The current value.
Return type: integer

ReplabPath¶

replab.globals.replabPath(newValue)¶

Get/set the root RepLAB folder (i.e. the folder containing src and replab_init)

If called without argument, returns the stored value.

The call with one argument changes the stored value; it should only be called as part of replab_init.

The stored value survives clear all as this function is locked.

Parameters: newValue (charstring, optional) – Sets the stored value
Returns: Path of the root RepLAB folder
Return type: charstring

RunsInMatlabEmacs¶

replab.globals.runsInMatlabEmacs(newValue)¶: Returns whether the MATLAB/Octave shell is running in the matlab-emacs mode

StrMaxColumns¶

replab.globals.strMaxColumns(newValue)¶

Get/set the maximal number of columns to display when pretty printing

The default stored value is []; when the stored value is [], it returns the current terminal width; otherwise it returns the integer stored value.

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value, or computed terminal width
Return type: integer

StrMaxRows¶

replab.globals.strMaxRows(newValue)¶

Get/set the maximal number of rows to display when pretty printing

The default stored value is []; when the stored value is [], it returns the current terminal height; otherwise it returns the integer stored value.

Parameters: newValue (integer or [], optional) – Value to be stored if provided
Returns: Stored integer value, or computed terminal height
Return type: integer

UseReconstruction¶

replab.globals.useReconstruction(newValue)¶: Get/set whether to use the group reconstruction when computing equivariant projections

VerboseInit¶

replab.globals.verboseInit(newValue)¶: Get/set whether the initialization is verbose

Verbosity¶

replab.globals.verbosity(newValue)¶

Get/set the verbosity level

The levels are understood as follows:

1 is INFO, the standard log level indicating what is happening
2 is DEBUG, used for information that may be needed for diagnosing issues
3 is TRACE, the most fine-grained level of information, expect it to be very verbose

Parameters: newValue (integer, optional) – New value; if empty queries the global variable. 0 is silent, for 1/2/3 see list above
Returns: The stored value
Return type: integer

VerifiedArithmetic¶

replab.globals.verifiedArithmetic(newValue)¶: Get/set whether to use verified arithmetic

WarnOnMultipleMethodGroups¶

replab.globals.warnOnMultipleMethodGroups(newValue)¶: Get/set whether to use the group reconstruction when computing equivariant projections

Yolo¶

replab.globals.yolo(newValue)¶: Get/set whether to error on unsound error bounds