14.4.117  Typelocked_Matrix

The standard library Typelocked_Matrix api defines access to two-dimensional arrays specialized to hold a specific value type.

The Typelocked_Matrix api appears to be unimplemented at present.

The Typelocked_Matrix api source code is in src/lib/std/src/typelocked-matrix.api.

The above information is manually maintained and may contain errors.

api {    eqtype Array ;
    Vector ;
    Element ;
    Region  = {base:Array,  col:Int,  ncols:Null_Or(Int ), 
               nrows:Null_Or(Int ),  row:Int};
    Traversal = Traversal;
    rw_vector : (Int , Int , Element) -> Array;
    from_list : List(List(Element ) ) -> Array;
    tabulate : Traversal
               -> (Int , Int , ((Int , Int) -> Element)) -> Array;
    get : (Array , Int , Int) -> Element;
    set : (Array , Int , Int , Element) -> Void;
    dimensions : Array -> (Int , Int);
    columns : Array -> Int;
    rows : Array -> Int;
    row : (Array , Int) -> Vector;
    column : (Array , Int) -> Vector;
    copy : {dst:Array,  dst_col:Int,  dst_row:Int,  src:Region}
           -> Void;
    keyed_apply : Traversal
                  -> ((Int , Int , Element) -> Void)
                     -> Region -> Void;
    apply : Traversal -> (Element -> Void) -> Array -> Void;
    modifyi : Traversal
              -> ((Int , Int , Element) -> Element)
                 -> Region -> Void;
    modify : Traversal -> (Element -> Element) -> Array -> Void;
    foldi : Traversal
            -> ((Int , Int , Element , X) -> X) -> X -> Region -> X;
    fold : Traversal -> ((Element , X) -> X) -> X -> Array -> X;
};