kmath-ast/space.kscience.kmath.ast.rendering

Package-level declarations

Types

abstract class Binary(val operations: Collection<String>?) : FeaturedMathRenderer.RenderFeature

Abstract printing of unary operations that discards MST if their operation is not in operations or its type is not MST.Binary.

class BinaryMinus(val operations: Collection<String>?) : Binary

Handles binary nodes by producing BinaryMinusSyntax.

BinaryMinusSyntax

data class BinaryMinusSyntax(val operation: String, val left: OperandSyntax, val right: OperandSyntax) : BinarySyntax

Represents binary, infix subtraction (42 − 42).

class BinaryOperator(val operations: Collection<String>?) : Binary

Handles binary nodes by producing BinaryOperatorSyntax.

BinaryOperatorSyntax

data class BinaryOperatorSyntax(val operation: String, var prefix: MathSyntax, val left: MathSyntax, val right: MathSyntax) : BinarySyntax

Represents binary, prefix operator syntax (like f(a, b)).

class BinaryPlus(val operations: Collection<String>?) : Binary

Handles binary nodes by producing BinaryPlusSyntax.

BinaryPlusSyntax

data class BinaryPlusSyntax(val operation: String, val left: OperandSyntax, val right: OperandSyntax) : BinarySyntax

Represents binary, infix addition (42 + 42).

sealed class BinarySyntax : OperationSyntax

Binary node, which has only two children.

class Exponent(val operations: Collection<String>?) : Unary

Handles unary nodes by producing ExponentSyntax.

data class ExponentSyntax(val operation: String, val operand: OperandSyntax, var useOperatorForm: Boolean) : UnarySyntax

Represents exponential function.

FeaturedMathRenderer

open class FeaturedMathRenderer(val features: List<FeaturedMathRenderer.RenderFeature>) : MathRenderer

Implements MST render process with sequence of features.

FeaturedMathRendererWithPostProcess

open class FeaturedMathRendererWithPostProcess(val features: List<FeaturedMathRenderer.RenderFeature>, val stages: List<FeaturedMathRendererWithPostProcess.PostProcessPhase>) : FeaturedMathRenderer

Extends FeaturedMathRenderer by adding post-processing stages.

class Fraction(val operations: Collection<String>?) : Binary

Handles binary nodes by producing FractionSyntax.

data class FractionSyntax(val operation: String, val left: OperandSyntax, val right: OperandSyntax, var infix: Boolean) : BinarySyntax

Represents fraction with numerator and denominator.

InverseHyperbolicOperations

class InverseHyperbolicOperations(val operations: Collection<String>?) : Unary

Handles binary nodes by producing inverse UnaryOperatorSyntax with ar prefix instead of a.

InverseTrigonometricOperations

class InverseTrigonometricOperations(val operations: Collection<String>?) : Unary

Handles binary nodes by producing inverse UnaryOperatorSyntax with arc prefix instead of a.

LatexSyntaxRenderer

object LatexSyntaxRenderer : SyntaxRenderer

SyntaxRenderer implementation for LaTeX.

MathMLSyntaxRenderer

object MathMLSyntaxRenderer : SyntaxRenderer

SyntaxRenderer implementation for MathML.

fun interface MathRenderer

Renders MST to MathSyntax.

sealed class MathSyntax

Syntax node for mathematical typography.

class Multiplication(val operations: Collection<String>?) : Binary

Handles binary nodes by producing MultiplicationSyntax.

MultiplicationSyntax

data class MultiplicationSyntax(val operation: String, val left: OperandSyntax, val right: OperandSyntax, var times: Boolean) : BinarySyntax

Represents binary, infix multiplication in the form of coefficient (2 x) or with operator (x × 2).

data class NumberSyntax(var string: String) : TerminalSyntax

Represents a number.

data class OperandSyntax(val operand: MathSyntax, var parentheses: Boolean) : MathSyntax

Represents operand of a certain operator wrapped with parentheses or not.

OperationSyntax

sealed class OperationSyntax : MathSyntax

Node containing a certain operation.

OperatorNameSyntax

data class OperatorNameSyntax(var name: String) : TerminalSyntax

Represents special typing for operator name.

class Power(val operations: Collection<String>?) : Binary

Handles binary nodes by producing SuperscriptSyntax.

PrettyPrintFloats

class PrettyPrintFloats(val types: Set<KClass<out Number>>) : FeaturedMathRenderer.RenderFeature

Special printing for numeric types that are printed in form of ('-'? (DIGIT+ ('.' DIGIT+)? ('E' '-'? DIGIT+)? | 'Infinity')) | 'NaN'.

PrettyPrintIntegers

class PrettyPrintIntegers(val types: Set<KClass<out Number>>) : FeaturedMathRenderer.RenderFeature

Special printing for numeric types that are printed in form of '-'? DIGIT+.

class PrettyPrintPi(val symbols: Set<String>) : FeaturedMathRenderer.RenderFeature

Special printing for symbols meaning Pi.

data class RadicalSyntax(val operation: String, val operand: MathSyntax) : UnarySyntax

Represents radical with a node inside it (√x).

RadicalWithIndexSyntax

data class RadicalWithIndexSyntax(val operation: String, val left: MathSyntax, val right: MathSyntax) : BinarySyntax

Represents radical syntax with index (³√x).

SimplifyParentheses

class SimplifyParentheses(val precedenceFunction: (MathSyntax) -> Int) : FeaturedMathRendererWithPostProcess.PostProcessPhase

Removes unnecessary parentheses from OperandSyntax.

SpecialSymbolSyntax

data class SpecialSymbolSyntax(var kind: SpecialSymbolSyntax.Kind) : TerminalSyntax

Represents a usage of special symbols (e.g., ∞).

class SquareRoot(val operations: Collection<String>?) : Unary

Handles binary nodes by producing RadicalSyntax with no index.

SubscriptSyntax

data class SubscriptSyntax(val operation: String, val left: MathSyntax, val right: MathSyntax) : BinarySyntax

Represents a syntax node with subscript (x_i).

SuperscriptSyntax

data class SuperscriptSyntax(val operation: String, val left: MathSyntax, val right: MathSyntax) : BinarySyntax

Represents a syntax node with superscript (x²).

data class SymbolSyntax(var string: String) : TerminalSyntax

Represents a symbol.

fun interface SyntaxRenderer

Abstraction of writing MathSyntax as a string of an actual markup language. Typical implementation should involve traversal of MathSyntax with handling each subtype.

sealed class TerminalSyntax : MathSyntax

Terminal node, which should not have any children nodes.

abstract class Unary(val operations: Collection<String>?) : FeaturedMathRenderer.RenderFeature

Abstract printing of unary operations that discards MST if their operation is not in operations or its type is not MST.Unary.

class UnaryMinus(val operations: Collection<String>?) : Unary

Handles binary nodes by producing UnaryMinusSyntax.

UnaryMinusSyntax

data class UnaryMinusSyntax(val operation: String, val operand: OperandSyntax) : UnarySyntax

Represents prefix, unary minus operator (-x).

class UnaryOperator(val operations: Collection<String>?) : Unary

Handles unary nodes by producing UnaryOperatorSyntax.

UnaryOperatorSyntax

data class UnaryOperatorSyntax(val operation: String, var prefix: MathSyntax, val operand: OperandSyntax) : UnarySyntax

Represents unary, prefix operator syntax (like f(x)).

class UnaryPlus(val operations: Collection<String>?) : Unary

Handles unary nodes by producing UnaryPlusSyntax.

UnaryPlusSyntax

data class UnaryPlusSyntax(val operation: String, val operand: OperandSyntax) : UnarySyntax

Represents prefix, unary plus operator (+x).

sealed class UnarySyntax : OperationSyntax

Unary node, which has only one child.

Functions

renderWithStringBuilder

fun SyntaxRenderer.renderWithStringBuilder(node: MathSyntax): String

Calls SyntaxRenderer.render with given node and a new StringBuilder instance, and returns its content.

Properties

val BetterExponent: FeaturedMathRendererWithPostProcess.PostProcessPhase

Applies ExponentSyntax.useOperatorForm to ExponentSyntax when the operand contains a fraction, a superscript or a subscript to improve readability.

val BetterFraction: FeaturedMathRendererWithPostProcess.PostProcessPhase

Chooses FractionSyntax.infix depending on the context.

BetterMultiplication

val BetterMultiplication: FeaturedMathRendererWithPostProcess.PostProcessPhase

Removes unnecessary times (×) symbols from MultiplicationSyntax.

val PrintNumeric: FeaturedMathRenderer.RenderFeature

Prints any MST.Numeric as a NumberSyntax containing the Any.toString result of it.

val PrintSymbol: FeaturedMathRenderer.RenderFeature

Prints any Symbol as a SymbolSyntax containing the Symbol.identity of it.