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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
<!--
@license Apache-2.0
Copyright (c) 2018 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.
-->
# Cube Root
> Compute the [cube root][cube-root] of a double-precision floating-point number.
<section class="usage">
## Usage
```javascript
var cbrt = require( '@stdlib/math/base/special/cbrt' );
```
#### cbrt( x )
Computes the [cube root][cube-root] of a double-precision floating-point number.
```javascript
var v = cbrt( 64.0 );
// returns 4.0
v = cbrt( 27.0 );
// returns 3.0
v = cbrt( 0.0 );
// returns 0.0
v = cbrt( -0.0 );
// returns -0.0
v = cbrt( -9.0 );
// returns ~-2.08
v = cbrt( NaN );
// returns NaN
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var randu = require( '@stdlib/random/base/randu' );
var cbrt = require( '@stdlib/math/base/special/cbrt' );
var x;
var i;
for ( i = 0; i < 100; i++ ) {
x = (randu()*200.0) - 100.0;
console.log( 'cbrt(%d) = %d', x, cbrt( x ) );
}
```
</section>
<!-- /.examples -->
<!-- C interface documentation. -->
* * *
<section class="c">
## C APIs
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
<section class="intro">
</section>
<!-- /.intro -->
<!-- C usage documentation. -->
<section class="usage">
### Usage
```c
#include "stdlib/math/base/special/cbrt.h"
```
#### stdlib_base_cbrt( x )
Computes the cube root of a double-precision floating-point number.
```c
double y = stdlib_base_cbrt( 27.0 );
// returns 3.0
```
The function accepts the following arguments:
- **x**: `[in] double` input value.
```c
double stdlib_base_cbrt( const double x );
```
</section>
<!-- /.usage -->
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="notes">
</section>
<!-- /.notes -->
<!-- C API usage examples. -->
<section class="examples">
### Examples
```c
#include "stdlib/math/base/special/cbrt.h"
#include <stdio.h>
int main() {
double x[] = { 3.14, 9.00, 0.0, 0.0/0.0 };
double y;
int i;
for ( i = 0; i < 4; i++ ) {
y = stdlib_base_cbrt( x[ i ] );
printf( "cbrt(%lf) = %lf\n", x[ i ], y );
}
}
```
</section>
<!-- /.examples -->
</section>
<!-- /.c -->
<section class="links">
[cube-root]: https://en.wikipedia.org/wiki/Cube_root
</section>
<!-- /.links -->
|
