cox.jmatt.java.MathTools.markup.latex
Enum MathGenLatex.LaSymbol

java.lang.Object
  extended by java.lang.Enum<MathGenLatex.LaSymbol>
      extended by cox.jmatt.java.MathTools.markup.latex.MathGenLatex.LaSymbol
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MathGenLatex.LaSymbol>
Enclosing class:
MathGenLatex

public static enum MathGenLatex.LaSymbol
extends java.lang.Enum<MathGenLatex.LaSymbol>

This enum holds some of the (millions of) LaTeX symbols and commands used with mathematics. PLEASE NOTE: This list is not by any means complete or comprehensive! It will also grow with time. The symbols represented here should be available with a base LaTeX package and not require any external packages to be included. If a symbol does require an external package this will be noted in its description.

Some of the symbols are standalone, others allow parameters. Where needed the parameters are given through the format() methods. The order of the parameters is as they appear from left to right unless specified otherwise.

Binary relations and operations accept zero, one or two parameters. The first appears on the left of the symbol, the second on the right. The parameters are enclosed within curly braces to allow compound expressions if needed. This should not affect the output.

Font effect tags are named for the effect and NOT after the tag; e.g. 'ITALIC' is the '/textit...' tag. For font size effects the enum consants all begin with 'FS'. Note the 'large' tags differentiate between themselves by the number of 'L' characters in 'LARGE'.

Grouping symbol constructs all begin with GS and include the '/left' and '/right' directives in front of the specified variable-sized delimiters. All of these constructs take one parameter which is the markup to be included between the opening and closing symbols. This also includes (without the 'GS') certain 'wide' accents, such as the vector symbol, left arrow and tilde. Although these are not grouping symbols per se they can include groups of characters therefore they are classified as such.


Enum Constant Summary
ALLIN
          For all {} in {}, 2 params.
APPROX
          Binary relation: approximates (wavy equals).
BOLD
          Bold text, 1 param.
BOWTIE
          Binary relation: bowtie.
CDOT
          Binary operation: center-dot multiply.
CIRC
          Binary operation: circle-times.
CONG
          Binary relation: congruent.
DIV
          Binary operation: divide by.
EQUIV
          Binary relation: equivalent (tribar equals)
FRAC
          Fraction symbol, 2 params.
FSFOOTNOTE
          Font size 'footnote', 1 param.
FSHUGE
          Font size 'huge', 1 param.
FSLARGE
          Font size 'large', 1 param, spelling: 'L'.
FSLLARGE
          Font size 'Large', 1 param, spelling: 'LL'.
FSLLLARGE
          Font size 'LARGE', 1 param, spelling: 'LLL'.
FSNORMAL
          Font size 'normal', 1 param.
FSSCRIPT
          Font size 'scritpsize', 1 param.
FSSMALL
          Font size 'small', 1 param.
FSTINY
          Font size 'tiny', 1 param.
GEQ
          Binary relation: greater or equal.
GSANGLE
          Grouping symbol: angle brackets.
GSCURLY
          Grouping symbol: curly braces.
GSGROUP
          Grouping symbol: /lgroup and /rgroup.
GSPAREN
          Grouping symbol: parentheses.
GSSQUARE
          Grouping symbol: square brackets.
INT
          Single integral symbol, 0 to 3 params.
ITALIC
          Italicized text, 1 param.
LATEX
          This is the sequence for the LaTeX logo.
LEQ
          Binary relation: less or equal.
MONOSPACE
          Monospaced (teletype) text, 1 param.
NEQ
          Binary relation: not equal to.
NOTEXIST
          This is the 'not exist' symbol (slashed, backward 'E'), 0 params.
NOTIN
          This is the '/notin' symbol, 0 params.
OLARROW
          Overline left arrow, 1 param.
ORARROW
          Overline right arrow, 1 param.
OVERLINE
          Overlined text, 1 param.
PARALLEL
          Binary relation: parallel.
PERP
          Binary relation: perpendicular.
PROD
          Product symbol (uppercase pi), 0 to 3 params.
SIM
          Binary relation: similar.
SIMEQ
          Binary relation: similar or equal.
SLANT
          Slanted text, 1 param.
SMALLCAP
          Small caps, 1 param.
SQRT
          Radical symbol, 1 or 2 params.
SUBSET
          Binary relation: subset.
SUBSETEQ
          Binary relation: subset or equals.
SUM
          Summation symbol (uppercase sigma), 0 to 3 params.
SUPSET
          Binary relation: superset.
SUPSETEQ
          Binary relation: superset or equal.
TIMES
          Binary operation: multiplication symbol.
UNDERLINE
          Underlined text, 1 param.
 
Method Summary
 java.lang.String format()
          Calls format(null).
 java.lang.String format(java.lang.String... pParams)
          Return a symbol or command with all required parameters filled in.
 java.lang.String getFormat()
          Return this symbol's raw formatting template.
 int getParams()
          Return the number of parameters this symbol requires.
static MathGenLatex.LaSymbol valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MathGenLatex.LaSymbol[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NOTEXIST

public static final MathGenLatex.LaSymbol NOTEXIST
This is the 'not exist' symbol (slashed, backward 'E'), 0 params. This symbol is also used when another symbol cannot be found.


NOTIN

public static final MathGenLatex.LaSymbol NOTIN
This is the '/notin' symbol, 0 params.


LATEX

public static final MathGenLatex.LaSymbol LATEX
This is the sequence for the LaTeX logo.


FRAC

public static final MathGenLatex.LaSymbol FRAC
Fraction symbol, 2 params.


SQRT

public static final MathGenLatex.LaSymbol SQRT
Radical symbol, 1 or 2 params. First parameter is radicand, second is index.


SUM

public static final MathGenLatex.LaSymbol SUM
Summation symbol (uppercase sigma), 0 to 3 params. First param is lower limit, second is upper limit, third is the summand.


PROD

public static final MathGenLatex.LaSymbol PROD
Product symbol (uppercase pi), 0 to 3 params. First is the lower limit, second is upper limit, third is the factor expression.


INT

public static final MathGenLatex.LaSymbol INT
Single integral symbol, 0 to 3 params. First is lower limit, second is upper, third is the integrand.


APPROX

public static final MathGenLatex.LaSymbol APPROX
Binary relation: approximates (wavy equals).


BOWTIE

public static final MathGenLatex.LaSymbol BOWTIE
Binary relation: bowtie.


CONG

public static final MathGenLatex.LaSymbol CONG
Binary relation: congruent.


EQUIV

public static final MathGenLatex.LaSymbol EQUIV
Binary relation: equivalent (tribar equals)


NEQ

public static final MathGenLatex.LaSymbol NEQ
Binary relation: not equal to.


GEQ

public static final MathGenLatex.LaSymbol GEQ
Binary relation: greater or equal.


LEQ

public static final MathGenLatex.LaSymbol LEQ
Binary relation: less or equal.


PARALLEL

public static final MathGenLatex.LaSymbol PARALLEL
Binary relation: parallel.


PERP

public static final MathGenLatex.LaSymbol PERP
Binary relation: perpendicular.


SIM

public static final MathGenLatex.LaSymbol SIM
Binary relation: similar.


SIMEQ

public static final MathGenLatex.LaSymbol SIMEQ
Binary relation: similar or equal.


SUBSET

public static final MathGenLatex.LaSymbol SUBSET
Binary relation: subset.


SUBSETEQ

public static final MathGenLatex.LaSymbol SUBSETEQ
Binary relation: subset or equals.


SUPSET

public static final MathGenLatex.LaSymbol SUPSET
Binary relation: superset.


SUPSETEQ

public static final MathGenLatex.LaSymbol SUPSETEQ
Binary relation: superset or equal.


DIV

public static final MathGenLatex.LaSymbol DIV
Binary operation: divide by.


CIRC

public static final MathGenLatex.LaSymbol CIRC
Binary operation: circle-times.


CDOT

public static final MathGenLatex.LaSymbol CDOT
Binary operation: center-dot multiply.


TIMES

public static final MathGenLatex.LaSymbol TIMES
Binary operation: multiplication symbol.


ITALIC

public static final MathGenLatex.LaSymbol ITALIC
Italicized text, 1 param.


BOLD

public static final MathGenLatex.LaSymbol BOLD
Bold text, 1 param.


SLANT

public static final MathGenLatex.LaSymbol SLANT
Slanted text, 1 param.


SMALLCAP

public static final MathGenLatex.LaSymbol SMALLCAP
Small caps, 1 param.


MONOSPACE

public static final MathGenLatex.LaSymbol MONOSPACE
Monospaced (teletype) text, 1 param.


UNDERLINE

public static final MathGenLatex.LaSymbol UNDERLINE
Underlined text, 1 param.


OVERLINE

public static final MathGenLatex.LaSymbol OVERLINE
Overlined text, 1 param.


FSTINY

public static final MathGenLatex.LaSymbol FSTINY
Font size 'tiny', 1 param.


FSSCRIPT

public static final MathGenLatex.LaSymbol FSSCRIPT
Font size 'scritpsize', 1 param.


FSFOOTNOTE

public static final MathGenLatex.LaSymbol FSFOOTNOTE
Font size 'footnote', 1 param.


FSSMALL

public static final MathGenLatex.LaSymbol FSSMALL
Font size 'small', 1 param.


FSNORMAL

public static final MathGenLatex.LaSymbol FSNORMAL
Font size 'normal', 1 param.


FSLARGE

public static final MathGenLatex.LaSymbol FSLARGE
Font size 'large', 1 param, spelling: 'L'.


FSLLARGE

public static final MathGenLatex.LaSymbol FSLLARGE
Font size 'Large', 1 param, spelling: 'LL'.


FSLLLARGE

public static final MathGenLatex.LaSymbol FSLLLARGE
Font size 'LARGE', 1 param, spelling: 'LLL'.


FSHUGE

public static final MathGenLatex.LaSymbol FSHUGE
Font size 'huge', 1 param.


GSCURLY

public static final MathGenLatex.LaSymbol GSCURLY
Grouping symbol: curly braces.


GSPAREN

public static final MathGenLatex.LaSymbol GSPAREN
Grouping symbol: parentheses.


GSSQUARE

public static final MathGenLatex.LaSymbol GSSQUARE
Grouping symbol: square brackets.


GSANGLE

public static final MathGenLatex.LaSymbol GSANGLE
Grouping symbol: angle brackets.


GSGROUP

public static final MathGenLatex.LaSymbol GSGROUP
Grouping symbol: /lgroup and /rgroup.


ORARROW

public static final MathGenLatex.LaSymbol ORARROW
Overline right arrow, 1 param.


OLARROW

public static final MathGenLatex.LaSymbol OLARROW
Overline left arrow, 1 param.


ALLIN

public static final MathGenLatex.LaSymbol ALLIN
For all {} in {}, 2 params. This symbol combines the '/forall' and '/in' symbols for the expression '/forall <0> /in <1>'.

Method Detail

values

public static MathGenLatex.LaSymbol[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (MathGenLatex.LaSymbol c : MathGenLatex.LaSymbol.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static MathGenLatex.LaSymbol valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getParams

public int getParams()
Return the number of parameters this symbol requires.


getFormat

public java.lang.String getFormat()
Return this symbol's raw formatting template.


format

public java.lang.String format(java.lang.String... pParams)
Return a symbol or command with all required parameters filled in.


format

public java.lang.String format()
Calls format(null).