-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
104 lines (96 loc) · 2.22 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/* tslint:disable:max-line-length */
/* tslint:disable:max-file-line-count */
import abs = require( '@stdlib/math/special/abs' );
/**
* Interface describing the `special` namespace.
*/
interface Namespace {
/**
* Computes the absolute value.
*
* @param x - input value
* @param options - options
* @returns result
*
* @example
* var y = ns.abs( -1.0 );
* // returns 1.0
*
* @example
* var array = require( `@stdlib/ndarray/array` );
*
* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
*
* var y = ns.abs( x );
* // returns <ndarray>
*
* var v = y.get( 0, 1 );
* // returns 2.0
*
* @example
* var Float64Array = require( `@stdlib/array/float64` );
*
* var x = new Float64Array( [ -1.0, -2.0 ] );
*
* var y = ns.abs( x );
* // returns <Float64Array>[ 1.0, 2.0 ]
*
* @example
* var x = [ -1.0, -2.0 ];
*
* var y = ns.abs( x );
* // returns [ 1.0, 2.0 ]
*
* @example
* var array = require( `@stdlib/ndarray/array` );
*
* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
* var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
*
* var z = ns.abs.assign( x, y );
* // returns <ndarray>
*
* var bool = ( z === y );
* // returns true
*
* var v = y.get( 0, 1 );
* // returns 2.0
*
* @example
* var Float64Array = require( `@stdlib/array/float64` );
*
* var x = new Float64Array( [ -1.0, -2.0 ] );
* var y = new Float64Array( x.length );
*
* var z = ns.abs.assign( x, y );
* // returns <Float64Array>[ 1.0, 2.0 ]
*
* var bool = ( z === y );
* // returns true
*/
abs: typeof abs;
}
/**
* Special math functions.
*/
declare var ns: Namespace;
// EXPORTS //
export = ns;