numbat 1.23.0

A statically typed programming language for scientific computations with first class support for physical dimensions and units.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use crate::arithmetic::{Exponent, Rational};
use crate::{ast, typed_ast};

use num_traits::{CheckedAdd, CheckedDiv, CheckedMul, CheckedSub, FromPrimitive, Zero};

use super::{TypeCheckError, error::Result};

fn to_rational_exponent(exponent_f64: f64) -> Option<Exponent> {
    Rational::from_f64(exponent_f64)
}

/// Evaluates a limited set of expressions *at compile time*. This is needed to
/// support type checking of expressions like `(2 * meter)^(2*3 - 4)` where we
/// need to know not just the *type* but also the *value* of the exponent.
pub fn evaluate_const_expr(expr: &typed_ast::Expression) -> Result<Exponent> {
    let name =
        match expr {
            typed_ast::Expression::Scalar { span, value, .. } => {
                return Ok(to_rational_exponent(value.to_f64())
                    .ok_or(TypeCheckError::NonRationalExponent(*span))?);
            }
            typed_ast::Expression::UnaryOperator {
                op: ast::UnaryOperator::Negate,
                expr,
                ..
            } => {
                return Ok(-evaluate_const_expr(expr)?);
            }
            typed_ast::Expression::UnaryOperator {
                op: ast::UnaryOperator::Factorial(_),
                ..
            } => "factorial",
            typed_ast::Expression::UnaryOperator {
                op: ast::UnaryOperator::LogicalNeg,
                ..
            } => "logical",

            e @ typed_ast::Expression::BinaryOperator {
                op,
                lhs: lhs_expr,
                rhs: rhs_expr,
                ..
            } => {
                let lhs = evaluate_const_expr(lhs_expr)?;
                let rhs = evaluate_const_expr(rhs_expr)?;
                return match op {
                    typed_ast::BinaryOperator::Add => Ok(lhs
                        .checked_add(&rhs)
                        .ok_or_else(|| TypeCheckError::OverflowInConstExpr(expr.full_span()))?),
                    typed_ast::BinaryOperator::Sub => Ok(lhs
                        .checked_sub(&rhs)
                        .ok_or_else(|| TypeCheckError::OverflowInConstExpr(expr.full_span()))?),
                    typed_ast::BinaryOperator::Mul => Ok(lhs
                        .checked_mul(&rhs)
                        .ok_or_else(|| TypeCheckError::OverflowInConstExpr(expr.full_span()))?),
                    typed_ast::BinaryOperator::Div => {
                        if rhs == Rational::zero() {
                            Err(Box::new(
                                TypeCheckError::DivisionByZeroInConstEvalExpression(e.full_span()),
                            ))
                        } else {
                            Ok(lhs.checked_div(&rhs).ok_or_else(|| {
                                TypeCheckError::OverflowInConstExpr(expr.full_span())
                            })?)
                        }
                    }
                    typed_ast::BinaryOperator::Power => {
                        if rhs.is_integer() {
                            Ok(num_traits::checked_pow(
                                lhs,
                                rhs.to_integer().try_into().map_err(|_| {
                                    TypeCheckError::OverflowInConstExpr(expr.full_span())
                                })?,
                            )
                            .ok_or_else(|| TypeCheckError::OverflowInConstExpr(expr.full_span()))?)
                        } else {
                            Err(Box::new(TypeCheckError::UnsupportedConstEvalExpression(
                                e.full_span(),
                                "exponentiation with non-integer exponent",
                            )))
                        }
                    }
                    typed_ast::BinaryOperator::ConvertTo => Err(Box::new(
                        TypeCheckError::UnsupportedConstEvalExpression(e.full_span(), "conversion"),
                    )),
                    typed_ast::BinaryOperator::LessThan
                    | typed_ast::BinaryOperator::GreaterThan
                    | typed_ast::BinaryOperator::LessOrEqual
                    | typed_ast::BinaryOperator::GreaterOrEqual
                    | typed_ast::BinaryOperator::Equal
                    | typed_ast::BinaryOperator::NotEqual => Err(Box::new(
                        TypeCheckError::UnsupportedConstEvalExpression(e.full_span(), "comparison"),
                    )),
                    typed_ast::BinaryOperator::LogicalAnd
                    | typed_ast::BinaryOperator::LogicalOr => Err(Box::new(
                        TypeCheckError::UnsupportedConstEvalExpression(e.full_span(), "logical"),
                    )),
                };
            }
            typed_ast::Expression::Identifier { .. } => "variable",
            typed_ast::Expression::UnitIdentifier { .. } => "unit identifier",
            typed_ast::Expression::FunctionCall { .. } => "function call",
            typed_ast::Expression::CallableCall { .. } => "function call",
            typed_ast::Expression::Boolean(_, _) => "Boolean value",
            typed_ast::Expression::String(_, _) => "String",
            typed_ast::Expression::Condition { .. } => "Conditional",
            typed_ast::Expression::BinaryOperatorForDate { .. } => "binary operator for datetimes",
            typed_ast::Expression::InstantiateStruct { .. } => "instantiate struct",
            typed_ast::Expression::AccessField { .. } => "access field of struct",
            typed_ast::Expression::List { .. } => "lists",
            typed_ast::Expression::TypedHole(_, _) => "typed hole",
        };

    Err(Box::new(TypeCheckError::UnsupportedConstEvalExpression(
        expr.full_span(),
        name,
    )))
}