Package space.kscience.kmath.ast.rendering

Types

Binary

common

abstract class Binary(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.

BinaryMinus

common

@UnstableKMathAPI()

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

Handles binary nodes by producing BinaryMinusSyntax.

BinaryMinusSyntax

common

@UnstableKMathAPI()

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

Represents binary, infix subtraction (42 − 42).

BinaryOperator

common

@UnstableKMathAPI()

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

Handles binary nodes by producing BinaryOperatorSyntax.

BinaryOperatorSyntax

common

@UnstableKMathAPI()

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

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

BinaryPlus

common

@UnstableKMathAPI()

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

Handles binary nodes by producing BinaryPlusSyntax.

BinaryPlusSyntax

common

@UnstableKMathAPI()

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

Represents binary, infix addition (42 + 42).

BinarySyntax

common

@UnstableKMathAPI()

sealed class BinarySyntax : OperationSyntax

Binary node, which has only two children.

Exponent

common

@UnstableKMathAPI()

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

Handles unary nodes by producing ExponentSyntax.

ExponentSyntax

common

@UnstableKMathAPI()

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

Represents exponential function.

FeaturedMathRenderer

common

@UnstableKMathAPI()

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

Implements MST render process with sequence of features.

FeaturedMathRendererWithPostProcess

common

@UnstableKMathAPI()

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

Extends FeaturedMathRenderer by adding post-processing stages.

Fraction

common

@UnstableKMathAPI()

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

Handles binary nodes by producing FractionSyntax.

FractionSyntax

common

@UnstableKMathAPI()

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

Represents fraction with numerator and denominator.

InverseHyperbolicOperations

common

@UnstableKMathAPI()

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

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

InverseTrigonometricOperations

common

@UnstableKMathAPI()

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

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

LatexSyntaxRenderer

common

@UnstableKMathAPI()

object LatexSyntaxRenderer : SyntaxRenderer

SyntaxRenderer implementation for LaTeX.

MathMLSyntaxRenderer

common

@UnstableKMathAPI()

object MathMLSyntaxRenderer : SyntaxRenderer

SyntaxRenderer implementation for MathML.

MathRenderer

common

@UnstableKMathAPI()

fun fun interface MathRenderer

Renders MST to MathSyntax.

MathSyntax

common

@UnstableKMathAPI()

sealed class MathSyntax

Syntax node for mathematical typography.

Multiplication

common

@UnstableKMathAPI()

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

Handles binary nodes by producing MultiplicationSyntax.

MultiplicationSyntax

common

@UnstableKMathAPI()

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

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

NumberSyntax

common

@UnstableKMathAPI()

data class NumberSyntax(string: String) : TerminalSyntax

Represents a number.

OperandSyntax

common

@UnstableKMathAPI()

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

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

OperationSyntax

common

@UnstableKMathAPI()

sealed class OperationSyntax : MathSyntax

Node containing a certain operation.

OperatorNameSyntax

common

@UnstableKMathAPI()

data class OperatorNameSyntax(name: String) : TerminalSyntax

Represents special typing for operator name.

Power

common

@UnstableKMathAPI()

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

Handles binary nodes by producing SuperscriptSyntax.

PrettyPrintFloats

common

@UnstableKMathAPI()

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

Special printing for numeric types that are printed in form of ('-'?

PrettyPrintIntegers

common

@UnstableKMathAPI()

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

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

PrettyPrintPi

common

@UnstableKMathAPI()

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

Special printing for symbols meaning Pi.

RadicalSyntax

common

@UnstableKMathAPI()

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

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

RadicalWithIndexSyntax

common

@UnstableKMathAPI()

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

Represents radical syntax with index (³√x).

SimplifyParentheses

common

@UnstableKMathAPI()

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

Removes unnecessary parentheses from OperandSyntax.

SpecialSymbolSyntax

common

@UnstableKMathAPI()

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

Represents a usage of special symbols (e.g.

SquareRoot

common

@UnstableKMathAPI()

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

Handles binary nodes by producing RadicalSyntax with no index.

SubscriptSyntax

common

@UnstableKMathAPI()

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

Represents a syntax node with subscript (x_i).

SuperscriptSyntax

common

@UnstableKMathAPI()

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

Represents a syntax node with superscript (x²).

SymbolSyntax

common

@UnstableKMathAPI()

data class SymbolSyntax(string: String) : TerminalSyntax

Represents a symbol.

SyntaxRenderer

common

@UnstableKMathAPI()

fun fun interface SyntaxRenderer

Abstraction of writing MathSyntax as a string of an actual markup language.

TerminalSyntax

common

@UnstableKMathAPI()

sealed class TerminalSyntax : MathSyntax

Terminal node, which should not have any children nodes.

Unary

common

@UnstableKMathAPI()

abstract class Unary(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.

UnaryMinus

common

@UnstableKMathAPI()

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

Handles binary nodes by producing UnaryMinusSyntax.

UnaryMinusSyntax

common

@UnstableKMathAPI()

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

Represents prefix, unary minus operator (-x).

UnaryOperator

common

@UnstableKMathAPI()

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

Handles unary nodes by producing UnaryOperatorSyntax.

UnaryOperatorSyntax

common

@UnstableKMathAPI()

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

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

UnaryPlus

common

@UnstableKMathAPI()

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

Handles unary nodes by producing UnaryPlusSyntax.

UnaryPlusSyntax

common

@UnstableKMathAPI()

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

Represents prefix, unary plus operator (+x).

UnarySyntax

common

@UnstableKMathAPI()

sealed class UnarySyntax : OperationSyntax

Unary node, which has only one child.

Functions

renderWithStringBuilder

common

@UnstableKMathAPI()

fun SyntaxRenderer.renderWithStringBuilder(node: MathSyntax): String

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

Properties

BetterExponent

common

@UnstableKMathAPI()

val BetterExponent: FeaturedMathRendererWithPostProcess.PostProcessPhase

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

BetterFraction

common

@UnstableKMathAPI()

val BetterFraction: FeaturedMathRendererWithPostProcess.PostProcessPhase

Chooses FractionSyntax.infix depending on the context.

BetterMultiplication

common

@UnstableKMathAPI()

val BetterMultiplication: FeaturedMathRendererWithPostProcess.PostProcessPhase

Removes unnecessary times (×) symbols from MultiplicationSyntax.

PrintNumeric

common

@UnstableKMathAPI()

val PrintNumeric: FeaturedMathRenderer.RenderFeature

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

PrintSymbol

common

@UnstableKMathAPI()

val PrintSymbol: FeaturedMathRenderer.RenderFeature

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