|
23 | 23 | */ |
24 | 24 | interface Routine { |
25 | 25 | /** |
26 | | - * Constructs the parameters for a modified Givens plane rotation. |
27 | | - * |
28 | | - * @param d1 - scaling factor for the first vector component |
29 | | - * @param d2 - scaling factor for the second vector component |
30 | | - * @param x1 - first component of the first vector |
31 | | - * @param y1 - first component of the second vector |
32 | | - * @returns - output array containing the rotation parameters |
33 | | - * |
34 | | - * @example |
35 | | - * var out = drotmg( 3.0, 4.0, 1.5, 2.5 ); |
36 | | - * // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ] |
37 | | - * |
38 | | - * @example |
39 | | - * var out = drotmg( 3.0, 5.0, 1.0, 2.0 ); |
40 | | - * // returns <Float64Array>[ 1.0, 0.3, 0.0, 0.0, 0.5 ] |
41 | | - */ |
| 26 | + * Constructs the parameters for a modified Givens plane rotation. |
| 27 | + * |
| 28 | + * @param d1 - scaling factor for the first vector component |
| 29 | + * @param d2 - scaling factor for the second vector component |
| 30 | + * @param x1 - first component of the first vector |
| 31 | + * @param y1 - first component of the second vector |
| 32 | + * @returns - output array containing the rotation parameters |
| 33 | + * |
| 34 | + * @example |
| 35 | + * var out = drotmg( 3.0, 4.0, 1.5, 2.5 ); |
| 36 | + * // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ] |
| 37 | + * |
| 38 | + * @example |
| 39 | + * var out = drotmg( 3.0, 5.0, 1.0, 2.0 ); |
| 40 | + * // returns <Float64Array>[ 1.0, 0.3, 0.0, 0.0, 0.5 ] |
| 41 | + */ |
42 | 42 | ( d1: number, d2: number, x1: number, y1: number ): Float64Array; |
43 | 43 |
|
44 | 44 | /** |
45 | | - * Constructs the parameters for a modified Givens plane rotation. |
46 | | - * |
47 | | - * @param d1 - scaling factor for the first vector component |
48 | | - * @param d2 - scaling factor for the second vector component |
49 | | - * @param x1 - first component of the first vector |
50 | | - * @param y1 - first component of the second vector |
51 | | - * @param out - output array |
52 | | - * @param stride - index increment |
53 | | - * @param offset - starting index |
54 | | - * @returns - output array containing the rotation parameters |
55 | | - * |
56 | | - * @example |
57 | | - * var Float64Array = require( '@stdlib/array/float64' ); |
58 | | - * |
59 | | - * var out = new Float64Array( 5 ); |
60 | | - * |
61 | | - * var y = drotmg.assign( 3.0, 4.0, 1.5, 2.5, out, 1, 0 ); |
62 | | - * // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ] |
63 | | - * |
64 | | - * var bool = (y === out); |
65 | | - * // returns true |
66 | | - */ |
| 45 | + * Constructs the parameters for a modified Givens plane rotation. |
| 46 | + * |
| 47 | + * @param d1 - scaling factor for the first vector component |
| 48 | + * @param d2 - scaling factor for the second vector component |
| 49 | + * @param x1 - first component of the first vector |
| 50 | + * @param y1 - first component of the second vector |
| 51 | + * @param out - output array |
| 52 | + * @param stride - index increment |
| 53 | + * @param offset - starting index |
| 54 | + * @returns - output array containing the rotation parameters |
| 55 | + * |
| 56 | + * @example |
| 57 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 58 | + * |
| 59 | + * var out = new Float64Array( 5 ); |
| 60 | + * |
| 61 | + * var y = drotmg.assign( 3.0, 4.0, 1.5, 2.5, out, 1, 0 ); |
| 62 | + * // returns <Float64Array>[ 1.0, 0.45, 0.0, 0.0, 0.6 ] |
| 63 | + * |
| 64 | + * var bool = (y === out); |
| 65 | + * // returns true |
| 66 | + */ |
67 | 67 | assign( d1: number, d2: number, x1: number, y1: number, out: Float64Array, stride: number, offset: number ): Float64Array; |
68 | 68 | } |
69 | 69 |
|
|
0 commit comments