cc.redberry.core.context

Class OutputFormat

java.lang.Object

cc.redberry.core.context.OutputFormat

public final class OutputFormat
extends java.lang.Object

This enum defines formats of string representation of expressions in Redberry.

Since:

1.0

See Also:

Tensor.toString(OutputFormat), Indices.toString(OutputFormat), Tensor.toString()

Field Summary

Fields

Modifier and Type	Field and Description
static OutputFormat	Cadabra This format specifies expressions to be outputted in the LaTeX notation.
int	id Unique identifier.
static OutputFormat	LaTeX This format specifies expressions to be outputted in the LaTeX notation.
java.lang.String	lowerIndexPrefix Prefix, which specifies lower index (e.g.
static OutputFormat	Maple This format specifies expressions to be outputted in the LaTeX notation.
boolean	printMatrixIndices Specifies whether print matrix indices or not.
static OutputFormat	Redberry This format specifies expressions to be outputted in the LaTeX notation.
static OutputFormat	SimpleRedberry This format specifies expressions to be outputted in the LaTeX notation.
java.lang.String	upperIndexPrefix Prefix, which specifies upper index (e.g.
static OutputFormat	UTF8 This format specifies expressions to be outputted in the LaTeX notation.
static OutputFormat	WolframMathematica This format specifies expressions to be outputted in the LaTeX notation.

Method Summary

Modifier and Type	Method and Description
OutputFormat	doNotPrintMatrixIndices() Returns output format that will not print matrix indices.
java.lang.String	getPrefixFromIntState(int intState) Returns lowerIndexPrefix if intState == 0 and upperIndexPrefix if intState == 1
java.lang.String	getPrefixFromRawIntState(int rawIntState) Returns lowerIndexPrefix if intState == 0 and upperIndexPrefix if intState == 0x80000000
boolean	is(OutputFormat oth) Returns whether this and oth defines same format.
OutputFormat	printMatrixIndices() Returns output format that will always print matrix indices.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LaTeX

public static final OutputFormat LaTeX

This format specifies expressions to be outputted in the LaTeX notation. The produces strings can be simply putted in some LaTeX math environments and compiled via LaTeX compiler.

UTF8

public static final OutputFormat UTF8

This format specifies expressions to be outputted in the LaTeX notation. The produces strings can be simply putted in some LaTeX math environments and compiled via LaTeX compiler.

Redberry

public static final OutputFormat Redberry

This format specifies expressions to be outputted in the LaTeX notation. The produces strings can be simply putted in some LaTeX math environments and compiled via LaTeX compiler.

Cadabra

public static final OutputFormat Cadabra

This format specifies expressions to be outputted in the LaTeX notation. The produces strings can be simply putted in some LaTeX math environments and compiled via LaTeX compiler.

WolframMathematica

public static final OutputFormat WolframMathematica

This format specifies expressions to be outputted in the LaTeX notation. The produces strings can be simply putted in some LaTeX math environments and compiled via LaTeX compiler.

Maple

public static final OutputFormat Maple

This format specifies expressions to be outputted in the LaTeX notation. The produces strings can be simply putted in some LaTeX math environments and compiled via LaTeX compiler.

SimpleRedberry

public static final OutputFormat SimpleRedberry

This format specifies expressions to be outputted in the LaTeX notation. The produces strings can be simply putted in some LaTeX math environments and compiled via LaTeX compiler.

id

public final int id

Unique identifier.

upperIndexPrefix

public final java.lang.String upperIndexPrefix

Prefix, which specifies upper index (e.g. '^' in LaTeX)

lowerIndexPrefix

public final java.lang.String lowerIndexPrefix

Prefix, which specifies lower index (e.g. '_' in LaTeX)

printMatrixIndices

public final boolean printMatrixIndices

Specifies whether print matrix indices or not.

Method Detail

doNotPrintMatrixIndices

public OutputFormat doNotPrintMatrixIndices()

Returns output format that will not print matrix indices.

Returns:

output format that will not print matrix indices

printMatrixIndices

public OutputFormat printMatrixIndices()

Returns output format that will always print matrix indices.

Returns:

output format that will always print matrix indices

is

public boolean is(OutputFormat oth)

Returns whether this and oth defines same format.

Parameters:

oth - other format

Returns:

whether this and oth defines same format

getPrefixFromIntState

public java.lang.String getPrefixFromIntState(int intState)

Returns lowerIndexPrefix if intState == 0 and upperIndexPrefix if intState == 1

Parameters:

intState - int state (0 - lower, 1 - upper)

Returns:

prefix

getPrefixFromRawIntState

public java.lang.String getPrefixFromRawIntState(int rawIntState)

Returns lowerIndexPrefix if intState == 0 and upperIndexPrefix if intState == 0x80000000

Parameters:

rawIntState - int state (0 - lower, 0x80000000 - upper)

Returns:

prefix