kotunil/eu.sirotin.kotunil.core

Package-level declarations

Types

abstract class DerivedUnit(var value: Number, formula: Expression) : Expression

data class Dimensions(val factors: Set<Factor>) : UnitPresentation

Describes dimensions of an unit with help of factors. A factor describe one separate dimension.

open class Expression(var value: Double, val dimensions: Dimensions) : Comparable<Expression> , UnitPresentation

Implements expression of unit with given value and dimensions

data class Factor(val specification: UnitSpecification<*>, val powerValue: Double = 1.0) : Comparable<Factor>

Describes one dimension of unit as logical pair of specification and powerValue.

UnitPresentation

interface UnitPresentation

Defines functions for pretty printing and dimensional analysis of measured units.

UnitSpecification

data class UnitSpecification<T : Expression>(val unitSymbol: String, val categorySymbol: String, val presentationPriority: Int = 0, val creator: (v: Double) -> T)

Specifies unit with properties as unitSymbol e.g. 'm', categorySymbol as 'L', presentationPriority for pretty printing e.g. by metre and second should be 'ms' ans not 'sm'. and creation function creator.

Functions

infix fun Expression.^(degree: Number): Expression

Allows to power an expression to given degree

infix fun Number.^(degree: Number): Number

Allows to power an number to given degree

operator fun Expression.div(p: Expression): Expression

Allows to divide expressions.

operator fun Expression.div(x: Number): Expression

Allows to divide expression to number.

operator fun Number.div(p: Expression): Expression

Allows to divide number to expression.

operator fun Expression.minus(p: Expression): Expression

Allows to subtract expressions.

operator fun Dimensions.plus(other: Dimensions): Dimensions

Allows to add dimensions.

operator fun Expression.plus(other: Expression): Expression

Allows to add expressions.

fun Dimensions.pow(degree: Number): Dimensions

Allows to calculate dimension's power.

fun Expression.pow(degree: Number): Expression

Allows to power an expression to given degree

operator fun Expression.rem(other: Expression): Expression

Allows to calculate the remainder of truncating division of this value by the other value.

operator fun Dimensions.times(other: Dimensions): Dimensions

Allows to multiply dimensions.

operator fun Expression.times(other: Expression): Expression

Allows to multiply expressions.

operator fun Expression.times(multiplicative: Number): Expression

Allows to multiply expression and number.

operator fun Number.times(p: Expression): Expression

Allows to multiply number and expressions.

operator fun Expression.unaryMinus(): Expression

Implementation of -=

operator fun Expression.unaryPlus(): Expression

Implementation of +=

Properties

COMPATIBILITY_ERR_PREFIX

const val COMPATIBILITY_ERR_PREFIX: String

Prefix for mostly run-time errors.

const val ε: Double = 1.0E-12

Tolerance by double comparison