README

NAME
     TPL - Tensor Programming Library

SYNOPSIS
     tpl statements

     Index length [, lowerBound, stride]

DESCRIPTION
     TPL, a library in Nim, provides a familiar tensor notation
     for working with the Quantum EXpressions (QEX) lattice field
     theory framework.  It uses compile time macros to generate code
     from statements of tensor expressions, and in doing so transfer
     the complexity from user applications to TPL's code base.

     tpl
          The macro that receives a list of high level tensor
          statements and generate low level code.
     Index length [, lowerBound, stride]
          Generates an index type that runs from lowerBound, to
          lowerBound + stride * (length - 1).

EXAMPLE
     WIP

FILES
     src/TPL.nim
          The module for end user to import.
     doc/spec*
          Specifications.
     LICENSE
          MIT license.

SOURCE
     TPL.nim
          Export end user APIs.
     TPL/
          TPL internals.
     test/
          Tests.

SEE ALSO
     QEX: Quantum EXpressions
          https://github.com/jcosborn/qex
     Nim
          http://nim-lang.org

COMPATIBILITY
     WIP with Nim v0.17.3 as of 02/02/2018.

BUGS
     Only works in `proc`s.
     APIs will change.

HISTORY
     A complete rewrite began in April, 2017.
     The previous effort, which started at the end of 2015, is currently
     frozen in the branch `preserve'.