Skip to content

Undocumented variables in ferret #28

@olexandr-konovalov

Description

@olexandr-konovalov

This is the report about variables defined in ferret:

### Checking variables in "ferret", ver. 1.0.2
new global functions:
  EnableFerretOverloads( b )
  FerretOverloadsEnabled(  )
  OnDirectedGraph( graph, perm )*
  OnEdgeColouredDirectedGraph( graph, perm )*
  Solve( arg )
  SolveCoset( arg )*

new operations:
  ConInGroup( arg )
  ConInGroup( arg )
  ConStabilize( arg )
  ConStabilize( arg )

new categories:
  IsConstraint( ... )*

new representations:
  IsSimpleConstraint( ... )*

new methods:
  ConInGroup( G )
  ConInGroup( G, useroptions )
  ConStabilize( i, op )
  ConStabilize( list, op )
  ConStabilize( list, op, useroptions )
  ConStabilize( pp, m )
  ConStabilize( t, i )
  Intersection2( G, H )
    perm groups (from Ferret Package)

new other methods:
  StabilizerFuncOp( arg )*
    permutation group with domain
  StabilizerFuncOp( arg )*
    permutation group with generators list

new info classes:
  InfoFerret*
  InfoFerretDebug*
  InfoFerretOverloads*

other new globals (not write protected):
  PermGroupStabilizerFerretOp( arg )*
  _FERRET_DEFAULT_OPTIONS*
  _FERRET_ENABLE_OVERLOADS*
  _FerretHelperFuncs*
  _YAPB_FixedOrbits( group, domainsize, fixedpoints )*
  _YAPB_Globals*
  _YAPB_RepresentElement( group, list1, list2 )*
  _YAPB_addRef( obj )*
  _YAPB_checkRef( obj )*
  _YAPB_clearRefs(  )*
  _YAPB_fillRepElements( G, orb )*
  _YAPB_getBlockList( sc )*
  _YAPB_getInfoFerret(  )*
  _YAPB_getInfoFerretDebug(  )*
  _YAPB_getOrbitPart( g, maxval )*
  _YAPB_getOrbitalList( sc, maxval )*
  _YAPB_getPermTo( sc, i )*
  _YAPB_inGroup( p, g )*
  _YAPB_isGroupConj( p, g )*
  _YAPB_stabTime*

### Variables checked for "ferret", ver. 1.0.2

star means "undocumented". Indeed, the index is quite short:

ConInGroup 2.1-2 
ConStabilize, for a transformation or partial perm 2.1-1 
    for an object and an action 2.1-1 
EnableFerretOverloads 1.1-1 
Ferret package 1. 
FerretOverloadsEnabled 1.1-2 
Solve 2.1-3 

and it may be worth to check what else may be documented, perhaps at least Info class(es).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions