Symbol

symbol.spad line 1 [edit on github]

Basic and scripted symbols.

< : (%, %) -> Boolean

from PartialOrder

<= : (%, %) -> Boolean

from PartialOrder

= : (%, %) -> Boolean

from BasicType

> : (%, %) -> Boolean

from PartialOrder

>= : (%, %) -> Boolean

from PartialOrder

OMwrite : % -> String

from OpenMath

OMwrite : (%, Boolean) -> String

from OpenMath

OMwrite : (OpenMathDevice, %) -> Void

from OpenMath

OMwrite : (OpenMathDevice, %, Boolean) -> Void

from OpenMath

argscript : (%, List(OutputForm)) -> %

argscript(s, [a1, ..., an]) returns s arg-scripted by [a1, ..., an].

coerce : String -> %

coerce(s) converts the string s to a symbol.

coerce : % -> OutputForm

from CoercibleTo(OutputForm)

convert : % -> InputForm

from ConvertibleTo(InputForm)

convert : % -> Pattern(Float)

from ConvertibleTo(Pattern(Float))

convert : % -> Pattern(Integer)

from ConvertibleTo(Pattern(Integer))

convert : % -> Symbol

from ConvertibleTo(Symbol)

elt : (%, List(OutputForm)) -> %

elt(s, [a1, ..., an]) or s([a1, ..., an]) returns s subscripted by [a1, ..., an].

hash : % -> SingleInteger

from Hashable

hashUpdate! : (HashState, %) -> HashState

from Hashable

latex : % -> String

from SetCategory

max : (%, %) -> %

from OrderedSet

min : (%, %) -> %

from OrderedSet

name : % -> %

name(s) returns s without its scripts.

new : () -> %

new() returns a new symbol whose name starts with %.

new : % -> %

new(s) returns a new symbol whose name starts with %s.

patternMatch : (%, Pattern(Float), PatternMatchResult(Float, %)) -> PatternMatchResult(Float, %)

from PatternMatchable(Float)

patternMatch : (%, Pattern(Integer), PatternMatchResult(Integer, %)) -> PatternMatchResult(Integer, %)

from PatternMatchable(Integer)

resetNew : () -> Void

resetNew() resets the internals counters that new() and new(s) use to return distinct symbols every time.

sample : () -> %

sample() returns a sample of %

script : (%, List(List(OutputForm))) -> %

script(s, [a, b, c, d, e]) returns s with subscripts a, superscripts b, pre-superscripts c, pre-subscripts d, and argument-scripts e. Omitted components are taken to be empty. For example, script(s, [a, b, c]) is equivalent to script(s, [a, b, c, [], []]).

script : (%, Record(sub : List(OutputForm), sup : List(OutputForm), presup : List(OutputForm), presub : List(OutputForm), args : List(OutputForm))) -> %

script(s, [a, b, c, d, e]) returns s with subscripts a, superscripts b, pre-superscripts c, pre-subscripts d, and argument-scripts e.

scripted? : % -> Boolean

scripted?(s) is true if s has been given any scripts.

scripts : % -> Record(sub : List(OutputForm), sup : List(OutputForm), presup : List(OutputForm), presub : List(OutputForm), args : List(OutputForm))

scripts(s) returns all the scripts of s.

smaller? : (%, %) -> Boolean

from Comparable

string : % -> String

string(s) converts the symbol s to a string. Error: if the symbol is subscripted.

subscript : (%, List(OutputForm)) -> %

subscript(s, [a1, ..., an]) returns s subscripted by [a1, ..., an].

superscript : (%, List(OutputForm)) -> %

superscript(s, [a1, ..., an]) returns s superscripted by [a1, ..., an].

~= : (%, %) -> Boolean

from BasicType

ConvertibleTo(Symbol)

ConvertibleTo(Pattern(Float))

BasicType

PatternMatchable(Integer)

PatternMatchable(Float)

OrderedSet

ConvertibleTo(Pattern(Integer))

SetCategory

OpenMath

Comparable

Hashable

PartialOrder

CoercibleTo(OutputForm)

ConvertibleTo(InputForm)