package phantom-algebra

  1. Overview
  2. Docs

Module Phantom_algebra.InterfaceSource

Phantom algebra interfaces

This modules provides the interface implemented by the core module, splits in smaller logical units.

There are intended to be used by people interested by the type-level interface but not by the simple OCaml implementation provided.

Sourcetype k = float
Sourceexception Unexpected_ranks of int list
Sourcemodule type Core = sig ... end

Indexing

The two following module types provide a definition for indices and their associated type-level values and the indexing and slicing functions.

Sourcemodule type Index = sig ... end

Index data type

Sourcemodule type Indexing = sig ... end
Sourcemodule type Basic = sig ... end

Some useful linear algebra values and functions

Advanced modules

The following functions are useful when writing higher functions of which the output depends on the dimension or the rank, or with input of arbitrary dimensions or ranks. Note that type errors often become atrocious in this use case

Sourcemodule type Rank = sig ... end

Rank-related types

Sourcemodule type Dim = sig ... end

Dimension-related types

Sourcemodule type Matching = sig ... end
Sourcemodule type Cloning = sig ... end

Cloning a value is useful to duplicate the type-level information associated to this value when this value is provided as an function argument. This useful when using multiple time this value with functions performing different type-level computations.

Full interface

The module type S combines all previous interface together.

Sourcemodule type S = sig ... end