package owl-base

  1. Overview
  2. Docs
OCaml Scientific and Engineering Computing - Base

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (16)

Authors

  1. L
    Liang Wang

Maintainers

  1. L
    Liang Wang <ryanrhymes@gmail.com>

Sources

owl-1.0.2.tbz
sha256=38d210ce6c1c2f09631fd59951430e4f364b5ae036c71ed1b32ce559b2a29263
sha512=c468100556445384b9c6adad9c37b5a9b8c27db8be35f61979e65fafa88c60221b8bda0a9c06cfbbc8d4e216a1ed08a315dfefb45bb4f5f15aa82d4358f57567

doc/owl-base/Owl_exception/index.html

Module Owl_exception

Core function
val check : bool -> exn -> unit

``check p e`` raises the exception ``e`` if the predicate ``p`` is ``false``, otherwise returns ``unit``.

Parameters: * ``p``: predicate to check. * ``e``: exception to raise.

Returns: * ``unit``

val verify : bool -> (unit -> exn) -> unit

``verify p f`` calls the function ``f`` which further raises an exception if the predicate ``p`` is ``false``, otherwise returns ``unit``.

Parameters: * ``p``: predicate to check. * ``f``: function to raise the exception.

Returns: * ``unit``

val to_string : exn -> string

``to_string e`` converts an exception into a string containing more detailed information for debugging the code.

val pp_exception : Format.formatter -> exn -> unit

``pp_exception`` is the pretty printer for Owl exceptions.

Exception definition
exception CONV_INVALID_ARGUMENT

Input arguments of convolution operations are invalid.

exception NOT_IMPLEMENTED of string

Exception of not implemented yet.

exception NOT_SUPPORTED

Exception of not supported type.

exception FOUND

Exception of found an element.

exception NOT_FOUND

Exception of not found an element.

exception EMPTY_ARRAY

Exception of an empty array

exception TEST_FAIL

Unit Test fails.

exception INVALID_ARGUMENT of string

Input arguments are invalid.

exception INVALID_PROBABILITY of float

Invalid probability value, not within 0,1 range.

exception LINALG_MATRIX_DOT_SHAPE of int * int * int * int

Invalid matrix shapes for matrix dot product.

exception NON_NEGATIVE_INT of int

Fails if the input is negative.

exception NOT_SQUARE of int array

Fails if a matrix is not square.

exception NOT_MATRIX of int array

Fails if the input is not a matrix.

exception DIFFERENT_SHAPE of int array * int array

Fail if two ndarrays have different shape.

exception DIFFERENT_SIZE of int * int

Fail if two ndarrays have different size.

exception NOT_BROADCASTABLE

Fail if the shapes of multiple ndarrays are not broadcastable.

exception NOT_CONVERGE

Fail to converge.

exception MAX_ITERATION

Number of iteration exceeds the threshold.

exception SINGULAR

Exception of singular matrix.

exception NOT_SIMPLEX

Exception of not being simplex.

exception INDEX_OUT_OF_BOUND

Exception of index out of boundary.

exception ZOO_ILLEGAL_GIST_NAME

Exception of illegal gist name.