Karith/com.skyecodes.karith

Package-level declarations

Contains all the types, functions and properties that can be used in the Karith API.

Types

KthBuilder

interface KthBuilder

Common builder interface for KthContext.Builder and KthModule.Builder.

KthCalculationException

sealed class KthCalculationException : KthException

Represents exceptions that can be thrown while calculating the result, after parsing the expression.

KthCalculationResult

typealias KthCalculationResult = KthResult<Double, KthCalculationException>

KthConstant

interface KthConstant : KthElement

Constant token to be included in a KthModule or KthContext and used in an expression.

KthContext

interface KthContext

Contexts are the main entrypoint of the Karith API. Their primary function is to parse strings into expressions, which can then be calculated to obtain a result.

KthElement

sealed interface KthElement : KthToken

Common interface for KthOperator, KthFunction and KthConstant.

KthException

sealed class KthException : Exception

Base class for all exceptions thrown by Karith.

KthExpression

interface KthExpression

Expressions contain all the data needed to calculate an arithmetic expression when given input variables (if any are needed).

KthFunction

interface KthFunction : KthElement

Function token to be included in a KthModule or KthContext and used in an expression.

KthIllegalTokenException

class KthIllegalTokenException(val token: String, val position: Int) : KthParsingException

Thrown during tokenization if the input string contains an illegal token.

KthInsufficientOperandsException

class KthInsufficientOperandsException(val type: String, val name: String) : KthCalculationException

Thrown during calculation if a function / operator doesn't have enough arguments / operands.

KthMismatchedParenthesesException

class KthMismatchedParenthesesException(val index: Int) : KthParsingException

Thrown during token sorting if the input string contains mismatched parentheses.

KthModule

interface KthModule

A module is a collection of KthElements to be included in a KthContext.

KthOperator

interface KthOperator : KthElement

Operator token to be included in a KthModule or KthContext and used in an expression.

KthParsingAndCalculationResult

typealias KthParsingAndCalculationResult = KthResult<Double, out KthException>

KthParsingException

sealed class KthParsingException : KthException

Represents exceptions that can be thrown while parsing the expression, before calculating the result.

KthParsingResult

typealias KthParsingResult = KthResult<KthExpression, KthParsingException>

KthResult

sealed interface KthResult<T, E : KthException>

The base result class returned by all API methods used in parsing an expression or calculating a result. Can be either Success or Error.

KthToken

sealed interface KthToken

Base interface for all tokens can be parsed in a KthExpression.

KthUndefinedCombinerOperatorException

class KthUndefinedCombinerOperatorException(val position: Int) : KthParsingException

Thrown during tokenization if the input string requires a combiner operator and the context does not provide one.

KthUndefinedVariableException

class KthUndefinedVariableException(val variable: String) : KthCalculationException

Thrown during calculation if an input variable is not defined.

KthUnknownTokenException

class KthUnknownTokenException(val token: KthToken) : KthCalculationException

Thrown during calculation if it encounters an unknown token.

Functions

asConstant

fun String.asConstant(value: Number): KthConstant

Helper function to create a KthConstant using the receiving String as key.

asFunction

fun String.asFunction(function: (Double) -> Double): KthFunction

Helper function to create a KthFunction with one argument using the receiving String as key.

fun String.asFunction(function: (Double, Double) -> Double): KthFunction

Helper function to create a KthFunction with two arguments using the receiving String as key.

fun String.asFunction(argCount: Int, function: (DoubleArray) -> Double): KthFunction

Helper function to create a KthFunction using the receiving String as key.

asOperator

fun String.asOperator(precedence: Int, leftAssociative: Boolean = true, operation: (Double, Double) -> Double): KthOperator

Helper function to create a KthOperator using the receiving String as key.

buildModule

fun buildModule(block: KthModule.Builder.() -> Unit = {}): KthModule

Helper function to build a KthContext.

calculateResult

fun calculateResult(expression: String): KthParsingAndCalculationResult

Parses an arithmetic expression from the given string using the default context, then return its result.

calculateResult

@JvmName(name = "calculateResultExt")

fun String.calculateResult(): KthParsingAndCalculationResult

Parses an arithmetic expression from the receiving string using the default context, then return its result.

calculateResultWith

fun calculateResultWith(expression: String, vararg inputVars: Pair<String, Number>): KthParsingAndCalculationResult

Parses an arithmetic expression from the given string using the default context, then return its result.

calculateResultWith

@JvmName(name = "calculateResultWithExt")

fun String.calculateResultWith(vararg inputVars: Pair<String, Number>): KthParsingAndCalculationResult

Parses an arithmetic expression from the receiving string using the default context, then return its result.

createConstant

fun createConstant(key: String, value: Number): KthConstant

Helper function to create a KthConstant.

createFunction

fun createFunction(key: String, function: (Double) -> Double): KthFunction

Helper function to create a KthFunction with one argument.

fun createFunction(key: String, function: (Double, Double) -> Double): KthFunction

Helper function to create a KthFunction with two arguments.

fun createFunction(key: String, argCount: Int, function: (DoubleArray) -> Double): KthFunction

Helper function to create a KthFunction.

createOperator

fun createOperator(key: String, precedence: Int, leftAssociative: Boolean = true, operation: (Double, Double) -> Double): KthOperator

Helper function to create a KthOperator.

KthContext

fun KthContext(builder: KthContext.Builder.() -> Unit): KthContext

parseExpression

fun parseExpression(expression: String): KthParsingResult

Parses an arithmetic expression from the given string using the default context.

parseExpression

@JvmName(name = "parseExpressionExt")

fun String.parseExpression(): KthParsingResult

Parses an arithmetic expression from the receiving string using the default context.

parseExpressionWith

fun parseExpressionWith(expression: String, vararg declaredVars: String): KthParsingResult

Parses an arithmetic expression from the given string and declared variables using the default context.

parseExpressionWith

@JvmName(name = "parseExpressionWithExt")

fun String.parseExpressionWith(vararg declaredVars: String): KthParsingResult

Parses an arithmetic expression from the receiving string and declared variables using the default context.

withPowerOperator

fun KthContext.Builder.withPowerOperator()

Helper function to add the Operators.POWER operator to a KthContext builder.