Skip to content

Commit e5bfdff

Browse files
authored
docs: update functions descriptions in math/base/special/cceil
PR-URL: #3114 Reviewed-by: Athan Reines <[email protected]>
1 parent 79dc5cf commit e5bfdff

File tree

11 files changed

+29
-23
lines changed

11 files changed

+29
-23
lines changed

lib/node_modules/@stdlib/math/base/special/cceil/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# cceil
2222

23-
> Round a double-precision complex floating-point number toward positive infinity.
23+
> Round each component of a double-precision complex floating-point number toward positive infinity.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var cceil = require( '@stdlib/math/base/special/cceil' );
3232

3333
#### cceil( z )
3434

35-
Rounds a double-precision complex floating-point number toward positive infinity.
35+
Rounds each component of a double-precision complex floating-point number toward positive infinity.
3636

3737
```javascript
3838
var Complex128 = require( '@stdlib/complex/float64/ctor' );
@@ -106,7 +106,7 @@ for ( i = 0; i < 100; i++ ) {
106106

107107
#### stdlib_base_cceil( z )
108108

109-
Rounds a double-precision complex floating-point number toward positive infinity.
109+
Rounds each component of a double-precision complex floating-point number toward positive infinity.
110110

111111
```c
112112
#include "stdlib/complex/float64/ctor.h"

lib/node_modules/@stdlib/math/base/special/cceil/benchmark/c/benchmark.c

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,18 @@ static double rand_double( void ) {
9393
static double benchmark( void ) {
9494
double complex x;
9595
double complex y;
96+
double v[ 100 ];
9697
double elapsed;
9798
double t;
98-
double v;
9999
int i;
100100

101+
for ( i = 0; i < 100; i++ ) {
102+
v[ i ] = ( 1000.0 * rand_double() ) - 500.0;
103+
}
104+
101105
t = tic();
102106
for ( i = 0; i < ITERATIONS; i++ ) {
103-
v = ( 1000.0*rand_double() ) - 500.0;
104-
x = v + v*I;
107+
x = v[ i % 100 ] + v[ i % 100 ] *I;
105108
y = stdlib_base_ceil( creal( x ) ) + stdlib_base_ceil( cimag( x ) )*I;
106109
if ( creal( y ) != creal( y ) ) {
107110
printf( "unexpected result\n" );

lib/node_modules/@stdlib/math/base/special/cceil/benchmark/c/native/benchmark.c

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,21 +93,24 @@ static double rand_double( void ) {
9393
*/
9494
static double benchmark( void ) {
9595
double elapsed;
96-
double re;
97-
double im;
96+
double v[ 100 ];
97+
double re;
98+
double im;
9899
double t;
99-
double v;
100100
int i;
101101

102-
stdlib_complex128_t x;
103-
stdlib_complex128_t y;
102+
stdlib_complex128_t x;
103+
stdlib_complex128_t y;
104+
105+
for ( i = 0; i < 100; i++ ) {
106+
v[ i ] = ( 1000.0 * rand_double() ) - 500.0;
107+
}
104108

105109
t = tic();
106110
for ( i = 0; i < ITERATIONS; i++ ) {
107-
v = ( 1000.0*rand_double() ) - 500.0;
108-
x = stdlib_complex128( v, v );
111+
x = stdlib_complex128( v[ i % 100 ], v[ i % 100 ] );
109112
y = stdlib_base_cceil( x );
110-
stdlib_complex128_reim( y, &re, &im );
113+
stdlib_complex128_reim( y, &re, &im );
111114
if ( re != re ) {
112115
printf( "unexpected result\n" );
113116
break;

lib/node_modules/@stdlib/math/base/special/cceil/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( z )
3-
Rounds a double-precision complex floating-point number toward positive
4-
infinity.
3+
Rounds each component of a double-precision complex floating-point number
4+
toward positive infinity.
55

66
Parameters
77
----------

lib/node_modules/@stdlib/math/base/special/cceil/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import { Complex128 } from '@stdlib/types/complex';
2424

2525
/**
26-
* Rounds a double-precision complex floating-point number toward positive infinity.
26+
* Rounds each component of a double-precision complex floating-point number toward positive infinity.
2727
*
2828
* @param z - input value
2929
* @returns result

lib/node_modules/@stdlib/math/base/special/cceil/include/stdlib/math/base/special/cceil.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ extern "C" {
2929
#endif
3030

3131
/**
32-
* Rounds a double-precision complex floating-point number toward positive infinity.
32+
* Rounds each component of a double-precision complex floating-point number toward positive infinity.
3333
*/
3434
stdlib_complex128_t stdlib_base_cceil( const stdlib_complex128_t z );
3535

lib/node_modules/@stdlib/math/base/special/cceil/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Round a double-precision floating-point complex number toward positive infinity.
22+
* Round each component of a double-precision complex floating-point number toward positive infinity.
2323
*
2424
* @module @stdlib/math/base/special/cceil
2525
*

lib/node_modules/@stdlib/math/base/special/cceil/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var imag = require( '@stdlib/complex/float64/imag' );
2929
// MAIN //
3030

3131
/**
32-
* Rounds a complex number toward positive infinity.
32+
* Rounds each component of a double-precision complex floating-point number toward positive infinity.
3333
*
3434
* @param {Complex128} z - complex number
3535
* @returns {Complex128} result

lib/node_modules/@stdlib/math/base/special/cceil/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var addon = require( './../src/addon.node' );
2727
// MAIN //
2828

2929
/**
30-
* Rounds a complex number toward positive infinity.
30+
* Rounds each component of a double-precision complex floating-point number toward positive infinity.
3131
*
3232
* @private
3333
* @param {Complex128} z - complex number

lib/node_modules/@stdlib/math/base/special/cceil/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/special/cceil",
33
"version": "0.0.0",
4-
"description": "Round a double-precision complex floating-point number toward positive infinity.",
4+
"description": "Round each component of a double-precision complex floating-point number toward positive infinity.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)