Data.SigFig.Types

Basic types and convenience functions for constructing your own terms and expression trees.

Documentation

data Term

The basic datatype to represent measurements, constant terms, and evaluation results

Constructors

Measured

A measured value with a finite number of significant figures and an associated value

Fields

• numSigFigs :: Integer
• value :: BigDecimal

Constant Rational

A constant value with infinite significant figures

Instances

Show Term

Defined in Data.SigFig.Types

Methods

showsPrec :: Int -> Term -> ShowS

show :: Term -> String

showList :: [Term] -> ShowS

Eq Term

Defined in Data.SigFig.Types

Methods

(==) :: Term -> Term -> Bool

(/=) :: Term -> Term -> Bool

data Op

The types of (infix) operators

Constructors

Add

Sub

Mul

Div

Instances

Show Op

Defined in Data.SigFig.Types

Methods

showsPrec :: Int -> Op -> ShowS

show :: Op -> String

showList :: [Op] -> ShowS

Eq Op

Defined in Data.SigFig.Types

Methods

(==) :: Op -> Op -> Bool

(/=) :: Op -> Op -> Bool

data Expr

A datatype to represent (not-yet-evaluated) expressions. Use parse to create such an expression from text.

Constructors

Leaf Term

Leaf of an expression

Prec1 [(Op, Expr)]

Operation of "Precedence 1": addition and subtraction

Prec2 [(Op, Expr)]

Operation of "Precedence 2": multiplication and division

Exp Expr Integer

Exponentiation with a constant integer exponent

Apply Function Expr

Application of a function to an expression argument

Instances

Show Expr

Defined in Data.SigFig.Types

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

Eq Expr

Defined in Data.SigFig.Types

Methods

(==) :: Expr -> Expr -> Bool

(/=) :: Expr -> Expr -> Bool

data Function

A datatype representing the supported functions.

Constructors

Log10

The function log() in expressions.

Antilog10

The function exp() in expressions.

Instances

Show Function

Defined in Data.SigFig.Types

Methods

showsPrec :: Int -> Function -> ShowS

show :: Function -> String

showList :: [Function] -> ShowS

Eq Function

Defined in Data.SigFig.Types

Methods

(==) :: Function -> Function -> Bool

(/=) :: Function -> Function -> Bool

Creating Terms and Expression Trees

measured :: Integer -> Rational -> Term

Create a measured value

constant :: Rational -> Term

Create a constant value

l :: Term -> Expr

Create a leaf node out of a term, like a "singleton".

lMeasured :: Integer -> Rational -> Expr

Create a leaf node and construct the Measured value argument at the same time. Convenience function.

lConstant :: Rational -> Expr

Create a leaf node and construct the Constant value argument at the same time. Convenience function.

Building and Combining Expression Trees

add :: [Expr] -> Expr

Add together a list of Exprs and create a new Expr.

add a b c is similar in idea to a + b + c.

sub :: [Expr] -> Expr

"Subtract together" a list of Exprs and create a new Expr.

sub a b c is similar in idea to a - b - c.

mul :: [Expr] -> Expr

multiply together a list of Exprs and create a new Expr.

mul a b c is similar in idea to a * b * c.

div :: [Expr] -> Expr

"Divide together" a list of Exprs and create a new Expr.

div a b c is similar in idea to a / b / c.

exp :: Expr -> Integer -> Expr

Take an Expr to the power of an integer. Equivalent to Exp.

apply :: Function -> Expr -> Expr

Apply a function to an Expr. Equivalent to Apply.