atscntrb-hx-intinf/README.md

A simple package based on libgmp for arithmetic operations (plus some other common operations on integers)

# Intinf

A simple package based on libgmp for arithmetic operations
(plus some other common operations on integers)

## Description

###SATS Files

1. SATS/intinf.sats: The abstract types
`intinf_type(int)` (nonlin) and `intinf_vtype(int)` (linear)
are introduced, and a few functions are declared for going between
values of these two types. Given a static integer `i`, the type
`intinf_type(i)` is for a dynamic value representing `i` while the
type `intinf_vtype(i)` is for a (linear) dynamic value representing `i`.

2. SATS/intinf_t.sats: The interface for
arithmetic operations and some other operations on integers represented
as dynamic values of the type `intinf_type`. In general, using functions
declared in `intinf_t.sats` may require some support of GC.

3. SATS/intinf_vt.sats: The interface for
arithmetic operations and some other operations on integers represented
as linear dynamic values of the type `intinf_vtype`. While it is a bit more
involved to use functions declared in `intinf_vt.sats` than in `intinf_t.sats`,
the resulting code can be significantly more efficent both time-wise and
memory-wise.

###DATS Files

1. DATS/intinf_t.dats:
   The file contains implementation for the templates declared in `intinf_t.sats`.

2. DATS/intinf_vt.dats:
   The file contains implementation for the templates declared in `intinf_vt.sats`.

3. DATS/gintinf_t.dats:
   The file contains implementation for using values of the type `intinf_type` as
   gnumbers (generic numbers).

###TEST Files

The files in the TEST directory contain code that gives details on using various
templates implemented in this package.