lib-tan-core 0.16.0

The core library
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
use rust_decimal_macros::dec;

use tan::{
    context::Context,
    error::Error,
    expr::{annotate_type, Expr},
    util::{
        args::{unpack_float_arg, unpack_int_arg},
        module_util::require_module,
    },
};

// #todo Split into multiple files, int, float, time, date, etc...

// #todo rename rust implementations to {type}_{func}.

// #insight
// Named `arithmetic` as those operators can apply to non-numbers, e.g. Time, Date

// #todo use AsRef, to avoid Annotated!
// #todo use macros to generate specializations for generic versions.
// #todo deduct from type if the function can affect the env or have any other side-effects.

// #todo ranges for arguments is too detailed, most probably we do not have the ranges!
// #todo support invalid_arguments without range.

// #fixme (+ 1.2 1.4 1.5) does not work, falls back to Int (more than 2 arguments)

// #todo autogen with a macro!
pub fn add_int(args: &[Expr]) -> Result<Expr, Error> {
    let mut xs = Vec::new();

    for arg in args {
        let Some(n) = arg.as_int() else {
            // #todo we could return the argument position here and enrich the error upstream.
            // #todo hmm, the error is too precise here, do we really need the annotations?
            return Err(Error::invalid_arguments(
                &format!("{arg} is not an Int"),
                arg.range(),
            ));
        };
        xs.push(n);
    }

    let sum = add_int_impl(xs);

    Ok(Expr::Int(sum))
}

// #insight example of splitting wrapper from impl.
fn add_int_impl(xs: Vec<i64>) -> i64 {
    xs.iter().sum()
}

pub fn add_float(args: &[Expr]) -> Result<Expr, Error> {
    let mut sum = 0.0;

    for arg in args {
        let Some(n) = arg.as_float() else {
            return Err(Error::invalid_arguments(
                &format!("{arg} is not a Float"),
                arg.range(),
            ));
        };
        sum += n;
    }

    Ok(Expr::Float(sum))
}

// #todo Move to dec.rs
pub fn add_dec(args: &[Expr]) -> Result<Expr, Error> {
    let mut sum = dec!(0.0);

    for arg in args {
        let Some(n) = arg.as_decimal() else {
            return Err(Error::invalid_arguments(
                &format!("{arg} is not a Dec"),
                arg.range(),
            ));
        };
        sum += n;
    }

    Ok(Expr::Dec(sum))
}

// #todo keep separate, optimized version with just 2 arguments!
// #todo should support variable args.
// #todo should return the error without range and range should be added by caller.
// pub fn sub_int(args: &[Expr]) -> Result<Expr, Error> {
//     // #todo support multiple arguments.
//     let [a, b] = args else {
//         return Err(Error::invalid_arguments(
//             "- requires at least two arguments",
//             None,
//         ));
//     };

//     let Some(a) = a.as_int() else {
//         return Err(Error::invalid_arguments(
//             &format!("{a} is not an Int"),
//             a.range(),
//         ));
//     };
//
//     let Some(b) = b.as_int() else {
//         return Err(Error::invalid_arguments(
//             &format!("{b} is not an Int"),
//             b.range(),
//         ));
//     };
//
//     Ok(Expr::Int(a - b))
// }

pub fn sub_int(args: &[Expr]) -> Result<Expr, Error> {
    // #todo what if there is a single argument?

    let mut diff = unpack_int_arg(args, 0, "n")?;

    for arg in args.iter().skip(1) {
        let Some(n) = arg.as_int() else {
            return Err(Error::invalid_arguments(
                &format!("{arg} is not an Int"),
                arg.range(),
            ));
        };
        diff -= n;
    }

    Ok(Expr::Int(diff))
}

pub fn neg_int(args: &[Expr]) -> Result<Expr, Error> {
    // #todo What about 0?
    let n = unpack_int_arg(args, 0, "n")?;
    Ok(Expr::Int(-n))
}

pub fn sub_float(args: &[Expr]) -> Result<Expr, Error> {
    // #todo support multiple arguments.
    let [a, b] = args else {
        return Err(Error::invalid_arguments(
            "- requires at least two arguments",
            None,
        ));
    };

    let Some(a) = a.as_float() else {
        return Err(Error::invalid_arguments(
            &format!("{a} is not a Float"),
            a.range(),
        ));
    };

    let Some(b) = b.as_float() else {
        return Err(Error::invalid_arguments(
            &format!("{b} is not a Float"),
            b.range(),
        ));
    };

    Ok(Expr::Float(a - b))
}

pub fn neg_float(args: &[Expr]) -> Result<Expr, Error> {
    let n = unpack_float_arg(args, 0, "n")?;
    Ok(Expr::Float(-n))
}

pub fn mul_int(args: &[Expr]) -> Result<Expr, Error> {
    // #todo optimize!
    let mut product = 1;

    for arg in args {
        let Some(n) = arg.as_int() else {
            return Err(Error::invalid_arguments(
                &format!("{arg} is not an Int"),
                arg.range(),
            ));
        };
        product *= n;
    }

    Ok(Expr::Int(product))
}

pub fn mul_float(args: &[Expr]) -> Result<Expr, Error> {
    // #todo optimize!
    let mut product = 1.0;

    for arg in args {
        let Some(n) = arg.as_float() else {
            return Err(Error::invalid_arguments(
                &format!("{arg} is not a Float"),
                arg.range(),
            ));
        };
        product *= n;
    }

    Ok(Expr::Float(product))
}

pub fn div_int(args: &[Expr]) -> Result<Expr, Error> {
    // #todo optimize!
    let mut quotient = unpack_int_arg(args, 0, "n")?;

    for arg in args.iter().skip(1) {
        let Some(n) = arg.as_int() else {
            return Err(Error::invalid_arguments(
                &format!("{arg} is not an Int"),
                arg.range(),
            ));
        };

        quotient /= n;
    }

    Ok(Expr::Int(quotient))
}

// #todo support int/float.
pub fn div_float(args: &[Expr]) -> Result<Expr, Error> {
    // #todo optimize!
    let mut quotient = f64::NAN;

    // #todo check for divide by zero! even statically check!
    // #todo actually, divide by zero should return Infinity, not panic!!

    for arg in args {
        let Some(n) = arg.as_float() else {
            return Err(Error::invalid_arguments(
                &format!("{arg} is not a Float"),
                arg.range(),
            ));
        };

        if quotient.is_nan() {
            quotient = n;
        } else {
            quotient /= n;
        }
    }

    Ok(Expr::Float(quotient))
}

pub fn mod_int(args: &[Expr]) -> Result<Expr, Error> {
    // #todo what are good variable names.
    let x = unpack_int_arg(args, 0, "x")?;
    let y = unpack_int_arg(args, 1, "y")?;

    Ok(Expr::Int(x % y))
}

pub fn mod_float(args: &[Expr]) -> Result<Expr, Error> {
    // #todo what are good variable names.
    let x = unpack_float_arg(args, 0, "x")?;
    let y = unpack_float_arg(args, 1, "y")?;

    Ok(Expr::Float(x % y))
}

// #todo should be associated with `Ordering` and `Comparable`.
pub fn int_compare(args: &[Expr]) -> Result<Expr, Error> {
    // #todo support multiple arguments.
    let [a, b] = args else {
        return Err(Error::invalid_arguments(
            "requires at least two arguments",
            None,
        ));
    };

    let Some(a) = a.as_int() else {
        return Err(Error::invalid_arguments(
            &format!("{a} is not an Int"),
            a.range(),
        ));
    };

    let Some(b) = b.as_int() else {
        return Err(Error::invalid_arguments(
            &format!("{b} is not an Int"),
            b.range(),
        ));
    };

    // #todo temp hack until Tan has enums?
    let ordering = match a.cmp(&b) {
        std::cmp::Ordering::Less => -1,
        std::cmp::Ordering::Equal => 0,
        std::cmp::Ordering::Greater => 1,
    };

    Ok(Expr::Int(ordering))
}

pub fn setup_lib_arithmetic(context: &mut Context) {
    let module = require_module("prelude", context);

    // #todo notice the use of annotate_type.

    // #todo forget the mangling, implement with a dispatcher function, multi-function.
    module.insert_invocable("+", annotate_type(Expr::foreign_func(&add_int), "Int"));
    module.insert_invocable(
        "+$$Int$$Int",
        annotate_type(Expr::foreign_func(&add_int), "Int"),
    );
    // #todo #temp hack to support multiple args.
    module.insert_invocable(
        "+$$Int$$Int$$Int",
        annotate_type(Expr::foreign_func(&add_int), "Int"),
    );
    module.insert_invocable(
        "+$$Int$$Int$$Int$$Int",
        annotate_type(Expr::foreign_func(&add_int), "Int"),
    );
    module.insert_invocable(
        "+$$Float$$Float",
        // #todo add the proper type: (Func Float Float Float)
        // #todo even better: (Func (Many Float) Float)
        annotate_type(Expr::foreign_func(&add_float), "Float"),
    );
    // #todo #temp hack to support multiple args.
    module.insert_invocable(
        "+$$Float$$Float$$Float",
        // #todo add the proper type: (Func Float Float Float)
        // #todo even better: (Func (Many Float) Float)
        annotate_type(Expr::foreign_func(&add_float), "Float"),
    );
    module.insert_invocable(
        "+$$Float$$Float$$Float$$Float",
        // #todo add the proper type: (Func Float Float Float)
        // #todo even better: (Func (Many Float) Float)
        annotate_type(Expr::foreign_func(&add_float), "Float"),
    );
    module.insert_invocable(
        "+$$Dec$$Dec",
        // #todo add the proper type: (Func Dec Dec Dec)
        // #todo even better: (Func (Many Dec) Dec)
        annotate_type(Expr::foreign_func(&add_dec), "Dec"),
    );
    module.insert_invocable("-", Expr::foreign_func(&sub_int));
    module.insert_invocable("-$$Int", annotate_type(Expr::foreign_func(&neg_int), "Int"));
    module.insert_invocable(
        "-$$Int$$Int",
        annotate_type(Expr::foreign_func(&sub_int), "Int"),
    );
    // #todo #hack implement a version of module.insert that automatically adds a few methods/overloads.
    module.insert_invocable(
        "-$$Int$$Int$$Int",
        annotate_type(Expr::foreign_func(&sub_int), "Int"),
    );
    module.insert_invocable(
        "-$$Int$$Int$$Int$$Int",
        annotate_type(Expr::foreign_func(&sub_int), "Int"),
    );
    module.insert_invocable(
        "-$$Float",
        annotate_type(Expr::foreign_func(&neg_float), "Float"),
    );
    module.insert_invocable(
        "-$$Float$$Float",
        annotate_type(Expr::foreign_func(&sub_float), "Float"),
    );
    module.insert_invocable("*", Expr::foreign_func(&mul_int));
    module.insert_invocable(
        "*$$Int$$Int",
        annotate_type(Expr::foreign_func(&mul_int), "Int"),
    );
    // #todo #temp hack to support multiple args.
    module.insert_invocable(
        "*$$Int$$Int$$Int",
        annotate_type(Expr::foreign_func(&mul_int), "Int"),
    );
    module.insert_invocable(
        "*$$Float$$Float",
        // #todo add the proper type: (Func Float Float Float)
        // #todo even better: (Func (Many Float) Float)
        annotate_type(Expr::foreign_func(&mul_float), "Float"),
    );
    module.insert_invocable(
        "*$$Float$$Float$$Float",
        // #todo add the proper type: (Func Float Float Float)
        // #todo even better: (Func (Many Float) Float)
        annotate_type(Expr::foreign_func(&mul_float), "Float"),
    );
    module.insert_invocable("/", annotate_type(Expr::foreign_func(&div_float), "Float"));
    module.insert_invocable(
        "/$$Int$$Int",
        annotate_type(Expr::foreign_func(&div_int), "Int"),
    );
    // #todo ultra-hack
    module.insert_invocable(
        "/$$Float$$Float",
        annotate_type(Expr::foreign_func(&div_float), "Float"),
    );
    // #todo ultra-hack
    module.insert_invocable(
        "/$$Float$$Float$$Float",
        annotate_type(Expr::foreign_func(&div_float), "Float"),
    );
    // #todo Add support for float exponentiation.
    // #todo shouldn't be required.
    module.insert_invocable("%", annotate_type(Expr::foreign_func(&mod_int), "Int"));
    module.insert_invocable(
        "%$$Int$$Int",
        annotate_type(Expr::foreign_func(&mod_int), "Int"),
    );
    module.insert_invocable(
        "%$$Float$$Float",
        annotate_type(Expr::foreign_func(&mod_float), "Float"),
    );
}