docs: add repl.txt

Author: aayush0325

lib/node_modules/@stdlib/lapack/base/dlarfb/docs/repl.txt

@@ -0,0 +1,192 @@
+{{alias}}( o, si, tr, dir, sto, M, N, K, V, LDV, T, LDT, C, LDC, W, LDWORK )
+    Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by
+    `N` matrix `C`, from either the left or the right.
+
+    Indexing is relative to the first index. To introduce an offset, use typed
+    array views.
+
+    The function applies the block reflector `H` to matrix `C` according to the
+    specified parameters. The `si` parameter determines whether the
+    transformation is applied from the left (`C = H*C` or `C = H^T*C`) or from
+    the right (`C = C*H` or `C = C*H^T`).
+
+    Parameters
+    ----------
+    o: string
+        Row-major (C-style) or column-major (Fortran-style) order. Must be
+        either 'row-major' or 'column-major'.
+
+    si: string
+        Specifies whether `H` or `H ^ T` is applied from the left or right.
+        Must be either 'left' or 'right'.
+
+    tr: string
+        Specifies whether to apply `H` or `H ^ T`. Must be either
+        'no-transpose' or 'transpose'.
+
+    dir: string
+        Indicates how `H` is formed from a product of elementary reflectors.
+        Must be either 'forward' or 'backward'.
+
+    sto: string
+        Indicates how the vectors which define the elementary reflectors are
+        stored. Must be either 'columns' or 'rows'.
+
+    M: integer
+        Number of rows of the matrix `C`.
+
+    N: integer
+        Number of columns of the matrix `C`.
+
+    K: integer
+        Order of the matrix `T`.
+
+    V: Float64Array
+        Input matrix.
+
+    LDV: integer
+        Leading dimension of `V`.
+
+    T: Float64Array
+        Input matrix (upper/lower triangular as dictated by `dir`/`sto`).
+
+    LDT: integer
+        Leading dimension of `T`.
+
+    C: Float64Array
+        Input/output matrix.
+
+    LDC: integer
+        Leading dimension of `C`.
+
+    W: Float64Array
+        Work array.
+
+    LDWORK: integer
+        Leading dimension of `W`.
+
+    Returns
+    -------
+    C: Float64Array
+        Updated matrix `C`.
+
+    Examples
+    --------
+    > var V = new {{alias:@stdlib/array/float64}}( [ 10.0, 40.0, 70.0, 20.0 ] );
+    > var T = new {{alias:@stdlib/array/float64}}( [ 1.0, 0.0, 0.0, 2.0 ] );
+    > var C = new {{alias:@stdlib/array/float64}}( [ 11.0, 12.0, 13.0, 21.0 ] );
+    > var W = new {{alias:@stdlib/array/float64}}( 4 );
+    > var o = 'row-major';
+    > var si = 'left';
+    > var tr = 'transpose';
+    > var dir = 'forward';
+    > var sto = 'columns';
+    > {{alias}}( o, si, tr, dir, sto, 2, 2, 2, V, 2, T, 2, C, 2, W, 2 )
+    <Float64Array>[ -910.0, -1470.0, -64483.0, -103761.0 ]
+
+
+{{alias}}.ndarray(si,tr,dir,sto,M,N,K,V,sv1,sv2,ov,T,st1,st2,ot,C,sc1,sc2,oc,W,sw1,sw2,ow)
+    Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by
+    `N` matrix `C`, from either the left or the right, using alternative
+    indexing semantics.
+
+    While typed array views mandate a view offset based on the underlying
+    buffer, the offset parameters support indexing semantics based on starting
+    indices.
+
+    Parameters
+    ----------
+    si: string
+        Specifies whether `H` or `H ^ T` is applied from the left or right.
+        Must be either 'left' or 'right'.
+
+    tr: string
+        Specifies whether to apply `H` or `H ^ T`. Must be either
+        'no-transpose' or 'transpose'.
+
+    dir: string
+        Indicates how `H` is formed from a product of elementary reflectors.
+        Must be either 'forward' or 'backward'.
+
+    sto: string
+        Indicates how the vectors which define the elementary reflectors are
+        stored. Must be either 'columns' or 'rows'.
+
+    M: integer
+        Number of rows of the matrix `C`.
+
+    N: integer
+        Number of columns of the matrix `C`.
+
+    K: integer
+        Order of the matrix `T`.
+
+    V: Float64Array
+        Input matrix.
+
+    sv1: integer
+        Stride of the first dimension of `V`.
+
+    sv2: integer
+        Stride of the second dimension of `V`.
+
+    ov: integer
+        Index offset for `V`.
+
+    T: Float64Array
+        Input matrix.
+
+    st1: integer
+        Stride of the first dimension of `T`.
+
+    st2: integer
+        Stride of the second dimension of `T`.
+
+    ot: integer
+        Index offset for `T`.
+
+    C: Float64Array
+        Input/output matrix.
+
+    sc1: integer
+        Stride of the first dimension of `C`.
+
+    sc2: integer
+        Stride of the second dimension of `C`.
+
+    oc: integer
+        Index offset for `C`.
+
+    W: Float64Array
+        Work array.
+
+    sw1: integer
+        Stride of the first dimension of `W`.
+
+    sw2: integer
+        Stride of the second dimension of `W`.
+
+    ow: integer
+        Index offset for `W`.
+
+    Returns
+    -------
+    C: Float64Array
+        Updated matrix `C`.
+
+    Examples
+    --------
+    > var V = new {{alias:@stdlib/array/float64}}( [ 10.0, 40.0, 70.0, 20.0 ] );
+    > var T = new {{alias:@stdlib/array/float64}}( [ 1.0, 0.0, 0.0, 2.0 ] );
+    > var C = new {{alias:@stdlib/array/float64}}( [ 11.0, 12.0, 13.0, 21.0 ] );
+    > var W = new {{alias:@stdlib/array/float64}}( 4 );
+    > var o = 'row-major';
+    > var si = 'left';
+    > var tr = 'transpose';
+    > var dir = 'forward';
+    > var sto = 'columns';
+    > {{alias}}.ndarray(si,tr,dir,sto,2,2,2, V,2,1,0, T,2,1,0, C,2,1,0, W,2,1,0)
+    <Float64Array>[ -910.0, -1470.0, -64483.0, -103761.0 ]
+
+    See Also
+    --------