@@ -55,14 +55,14 @@ dlacn2( 4, V, X, ISGN, EST, KASE, ISAVE );
5555The function has the following parameters:
5656
5757- ** N** : number of rows/columns in ` A ` .
58- - ** V** : workspace [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements, used internally to store intermediate vectors.
59- - ** X** : input/output [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements, contains the current or next matrix-vector product.
60- - ** ISGN** : [ ` Int32Array ` ] [ mdn-int32array ] having ` N ` indexed elements, stores the sign of each element in ` X ` during iterations.
61- - ** EST** : single-element [ ` Float64Array ` ] [ mdn-float64array ] , on output, contains the estimated one-norm of the matrix ` A ` .
58+ - ** V** : workspace [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements. This workspace is used internally to store intermediate vectors.
59+ - ** X** : input/output [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements. This array contains the current or next matrix-vector product.
60+ - ** ISGN** : [ ` Int32Array ` ] [ mdn-int32array ] having ` N ` indexed elements. This array stores the sign of each element in ` X ` during iterations.
61+ - ** EST** : single-element [ ` Float64Array ` ] [ mdn-float64array ] , on output. This array contains the estimated one-norm of the matrix ` A ` .
6262- ** KASE** : single-element [ ` Int32Array ` ] [ mdn-int32array ] that controls the reverse communication.
63- - ** ISAVE** : [ ` Int32Array ` ] [ mdn-int32array ] having 3 indexed elements, used internally to maintain state across multiple calls.
63+ - ** ISAVE** : [ ` Int32Array ` ] [ mdn-int32array ] having 3 indexed elements. This array is used internally to maintain state across multiple calls.
6464
65- The reverse communication takes place using ` KASE ` , it may have any of these values:
65+ The reverse communication takes place using ` KASE ` . The single-element in ` KASE ` may have the following values:
6666
6767- ` 0 ` : estimation is complete.
6868- ` 1 ` : caller must compute ` A * X ` and store the result back in ` X ` .
@@ -134,24 +134,24 @@ dlacn2.ndarray( 4, V, 1, 0, X, 1, 0, ISGN, 1, 0, EST, 0, KASE, 0, ISAVE, 1, 0 );
134134The function has the following parameters:
135135
136136- ** N** : number of rows/columns in ` A ` .
137- - ** V** : workspace [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements, used internally to store intermediate vectors.
137+ - ** V** : workspace [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements. This workspace is used internally to store intermediate vectors.
138138- ** sv** : stride length for ` V ` .
139139- ** ov** : starting index for ` V ` .
140- - ** X** : input/output [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements, contains the current or next matrix-vector product.
140+ - ** X** : input/output [ ` Float64Array ` ] [ mdn-float64array ] having ` N ` indexed elements. This array contains the current or next matrix-vector product.
141141- ** sx** : stride length for ` X ` .
142142- ** ox** : starting index for ` X ` .
143- - ** ISGN** : [ ` Int32Array ` ] [ mdn-int32array ] having ` N ` indexed elements, stores the sign of each element in ` X ` during iterations.
143+ - ** ISGN** : [ ` Int32Array ` ] [ mdn-int32array ] having ` N ` indexed elements. This array stores the sign of each element in ` X ` during iterations.
144144- ** sisgn** : stride length for ` ISGN ` .
145145- ** oisgn** : starting index for ` ISGN ` .
146- - ** EST** : single-element [ ` Float64Array ` ] [ mdn-float64array ] , on output, contains the estimated one-norm of the matrix ` A ` .
146+ - ** EST** : single-element [ ` Float64Array ` ] [ mdn-float64array ] , on output. This array contains the estimated one-norm of the matrix ` A ` .
147147- ** oe** : starting index for ` EST ` .
148148- ** KASE** : single-element [ ` Int32Array ` ] [ mdn-int32array ] that controls the reverse communication.
149149- ** ok** : starting index for ` KASE ` .
150- - ** ISAVE** : [ ` Int32Array ` ] [ mdn-int32array ] having 3 indexed elements, used internally to maintain state across multiple calls.
150+ - ** ISAVE** : [ ` Int32Array ` ] [ mdn-int32array ] having 3 indexed elements. This array is used internally to maintain state across multiple calls.
151151- ** sisave** : stride length for ` ISAVE ` .
152152- ** oisave** : starting index for ` ISAVE ` .
153153
154- The reverse communication takes place using ` KASE ` , it may have any of these values:
154+ The reverse communication takes place using ` KASE ` . The single-element in ` KASE ` may have the following values:
155155
156156- ` 0 ` : estimation is complete.
157157- ` 1 ` : caller must compute ` A * X ` and store the result back in ` X ` .
0 commit comments