Mike Gerwitz
28b83ad6a3
There's a lot to say about this; it's been a bit of a struggle figuring out what I wanted to do here. First: this allows objects to use `AsgObjectMut` to control whether an edge is permitted to be added, or to cache information about an edge that is about to be added. But no object does that yet; it just uses the default trait implementation, and so this _does not change any current behavior_. It also is approximately equivalent cycle-count-wise, according to Valgrind (within ~100 cycles out of hundreds of millions on large package tests). Adding edges to the graph is still infallible _after having received permission_ from an `ObjectIndexRelTo`, but the object is free to reject the edge with an `AsgError`. As an example of where this will be useful: the template system needs to keep track of what is in the body of a template as it is defined. But the `TplAirAggregate` parser is sidelined while expressions in the body are parsed, and edges are added to a dynamic source using `ObjectIndexRelTo`. Consequently, we cannot rely on a static API to cache information; we have to be able to react dynamically. This will allow `Tpl` objects to know any time edges are added and, therefore, determine their shape as the graph is being built, rather than having to traverse the tree after encountering a close. (I _could_ change this, but `ObjectIndexRelTo` removes a significant amount of complexity for the caller, so I'd rather not.) I did explore other options. I rejected the first one, then rejected this one, then rejected the first one again before returning back to this one after having previously sidelined the entire thing, because of the above example. The core point is: I need confidence that the graph isn't being changed in ways that I forgot about, and because of the complexity of the system and the heavy refactoring that I do, I need the compiler's help; otherwise I risk introducing subtle bugs as objects get out of sync with the actual state of the graph. (I wish the graph supported these things directly, but that's a project well outside the scope of my TAMER work. So I have to make do, as I have been all this time, by layering atop of Petgraph.) (...I'm beginning to ramble.) (...beginning?) Anyway: my other rejected idea was to provide attestation via the `ObjectIndex` APIs to force callers to go through those APIs to add an edge to the graph; it would use sealed objects that are inaccessible to any modules other than the objects, and assert that the caller is able to provide a zero-sized object of that sealed type. The problem with this is...exactly what was mentioned above: `ObjectIndexRelTo` is dynamic. We don't always know the source object type statically, and so we cannot make those static assertions. I could have tried the same tricks to store attestation at some other time, but what a confusing mess it would be. And so here we are. Most of this work is cleaning up the callers---adding edges is now fallible, from the `ObjectIndex` API standpoint, and so AIR needed to be set up to handle those failures. There _aren't_ any failures yet, but again, since things are dynamic, they could appear at any moment. Furthermore, since ref/def is commutative (things can be defined and referenced in any order), there could be surprise errors on edge additions in places that might not otherwise expect it in the future. We're now ready for that, and I'll be able to e.g. traverse incoming edges on a `Missing->Transparent` definition to notify dependents. This project is going to be the end of me. As interesting as it is. I can see why Rust just chose to require macro definitions _before_ use. So much less work. DEV-13163 |
||
---|---|---|
bin | ||
build-aux | ||
core | ||
design/tpl | ||
doc | ||
progtest | ||
rater | ||
src | ||
tamer | ||
test | ||
tools | ||
.gitignore | ||
.gitlab-ci.yml | ||
.gitmodules | ||
.rev-xmle | ||
.rev-xmlo | ||
COPYING | ||
COPYING.FDL | ||
HACKING | ||
Makefile.am | ||
README.md | ||
RELEASES.md | ||
VERSION.in | ||
bootstrap | ||
c1map.xsd | ||
configure.ac | ||
package-lock.json |
README.md
TAME
TAME is The Algebraic Metalanguage, a programming language and system of tools designed to aid in the development, understanding, and maintenance of systems performing numerous calculations on a complex graph of dependencies, conditions, and a large number of inputs.
This system was developed at Ryan Specialty Group (formerly LoVullo Associates) to handle the complexity of comparative insurance rating systems. It is a domain-specific language (DSL) that itself encourages, through the use of templates, the creation of sub-DSLs. TAME itself is at heart a calculator—processing only numerical input and output—driven by quantifiers as predicates. Calculations and quantifiers are written declaratively without concern for order of execution.
The system has powerful dependency resolution and data flow capabilities.
TAME consists of a macro processor (implementing a metalanguage), numerous compilers for various targets (JavaScript, HTML documentation and debugging environment, LaTeX, and others), linkers, and supporting tools. The input grammar is XML, and the majority of the project (including the macro processor, compilers, and linkers) is written in a combination of XSLT and Rust.
TAMER
Due to performance requirements, this project is currently being reimplemented in Rust. That project can be found in the tamer/ directory.
Documentation
Compiled documentation for the latest release is available via our GitLab mirror, which uses the same build pipeline as we do on our internal GitLab instance. Available formats are:
Getting Started
To get started, make sure Saxon version 9 or later is available and its path
set as SAXON_CP
; that the path to hoxsl is set via HOXSL
; and then run
the bootstrap
script:
$ export SAXON_CP=/path/to/saxon9he.jar
$ export HOXSL=/path/to/hoxsl/root
$ ./boostrap
Running Test Cases
To run the test cases, invoke make check
(or its alias, make test
).
Testing Core Features
In order to run tests located at core/test/core/**
, a supporting environment
is required. (e.g. mega rater). Inside a supporting rater, either check out a
submodule containing the core tests, or temporarily add them into the
submodule.
Build the core test suite summary page using:
$ make rater/core/test/core/suite.html
Visit the summary page in a web browser and click the Calculate Premium button. If all test cases pass, it will yield a value of $1.
Hacking
Information for TAME developers can be found in the file HACKING
.
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.