Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/base/cgemv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ float y[] = { 1.0f, 1.0f, 2.0f, 2.0f, 3.0f, 3.0f, 4.0f, 4.0f };
const stdlib_complex64_t alpha = stdlib_complex64( 0.5f, 0.5f );
const stdlib_complex64_t beta = stdlib_complex64( 0.5f, -0.5f );

c_cgemv( CblasNoTrans, 4, 2, alpha, (void *)A, 1, 4, (void *)x, 1, 0, beta, (void *)y, 1, 0 );
c_cgemv_ndarray( CblasNoTrans, 4, 2, alpha, (void *)A, 1, 4, 0, (void *)x, 1, 0, beta, (void *)y, 1, 0 );
```

The function accepts the following arguments:
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/blas/ext/base/dnancount/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ console.log( v );
Computes the number of non-`NaN` elements in a double-precision floating-point strided array.

```c
const double x[] = { 1.0, 2.0, NaN, 4.0, 5.0, 6.0, NaN, 8.0 };
const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 8.0 };

int v = stdlib_strided_dnancount( 4, x, 2 );
// returns 2
Expand All @@ -198,7 +198,7 @@ CBLAS_INT stdlib_strided_dnancount( const CBLAS_INT N, const double *X, const CB
Computes the number of non-`NaN` elements in a double-precision floating-point strided array using alternative indexing semantics.

```c
const double x[] = { 2.0, 1.0, NaN, -2.0, 3.0, 4.0, NaN, NaN };
const double x[] = { 2.0, 1.0, 0.0/0.0, -2.0, 3.0, 4.0, 0.0/0.0, 0.0/0.0 };

int v = stdlib_strided_dnancount_ndarray( 4, x, 2, 1 );
// returns 3
Expand Down
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/znancount/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,9 @@ Computes the number of non-`NaN` elements in a double-precision complex floating

const stdlib_complex128_t x[] = {
stdlib_complex128( 2.0, 1.0 ),
stdlib_complex128( NaN, -2.0 ),
stdlib_complex128( 0.0/0.0, -2.0 ),
stdlib_complex128( 3.0, 4.0 ),
stdlib_complex128( NaN, NaN )
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};

int v = stdlib_strided_znancount( 4, x, 1 );
Expand All @@ -218,9 +218,9 @@ Computes the number of non-`NaN` elements in a double-precision complex floating

const stdlib_complex128_t x[] = {
stdlib_complex128( 2.0, 1.0 ),
stdlib_complex128( NaN, -2.0 ),
stdlib_complex128( 0.0/0.0, -2.0 ),
stdlib_complex128( 3.0, 4.0 ),
stdlib_complex128( NaN, NaN )
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};

int v = stdlib_strided_znancount_ndarray( 4, x, 1, 0 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ bool = isComposite( NaN );
### Usage

```c
#include "stdlib/math/base/special/is_composite.h"
#include "stdlib/math/base/assert/is_composite.h"
```

#### stdlib_base_is_composite( x )
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/atan2/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@
* // returns 0.0
*
* @example
* double v = stdlib_base_atan2( 3.0, NaN );
* double v = stdlib_base_atan2( 3.0, 0.0/0.0 );
* // returns NaN
*
* @example
* double v = stdlib_base_atan2( NaN, 2.0 );
* double v = stdlib_base_atan2( 0.0/0.0, 2.0 );
* // returns NaN
*/
double stdlib_base_atan2( const double y, const double x ) {
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/atan2d/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@
* // returns 0.0
*
* @example
* double v = stdlib_base_atan2d( 3.0, NaN );
* double v = stdlib_base_atan2d( 3.0, 0.0/0.0 );
* // returns NaN
*
* @example
* double v = stdlib_base_atan2d( NaN, 2.0 );
* double v = stdlib_base_atan2d( 0.0/0.0, 2.0 );
* // returns NaN
*/
double stdlib_base_atan2d( const double y, const double x ) {
Expand Down
7 changes: 6 additions & 1 deletion lib/node_modules/@stdlib/math/base/special/cround/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,12 @@
* stdlib_complex128_t z = stdlib_complex128( -4.2, 5.5 );
*
* stdlib_complex128_t out = stdlib_base_cround( z );
* // returns <Complex128>[ -5.0, 6.0 ]
*
* double re = stdlib_complex128_real( out );
* // returns -4.0
*
* double im = stdlib_complex128_imag( out );
* // returns 6.0
*/
stdlib_complex128_t stdlib_base_cround( const stdlib_complex128_t z ) {
double re;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@
* // returns 4.2
*
* @example
* double v = stdlib_base_fast_max( 3.14, NaN );
* double v = stdlib_base_fast_max( 3.14, 0.0/0.0 );
* // returns NaN
*
* @example
* double v = stdlib_base_fast_max( NaN, 3.14 );
* double v = stdlib_base_fast_max( 0.0/0.0, 3.14 );
* // returns 3.14
*
* @example
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/gcd/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ static const int64_t STDLIB_CONSTANT_INT64_MAX = 9223372036854775807;
* @return greatest common divisor
*
* @example
* double out = largeIntegers( 1.2676506002282294.0e+30, 9007199254740992.0 );
* double out = largeIntegers( 1.2676506002282294e+30, 9007199254740992.0 );
* // returns 9007199254740992.0
*/
static double largeIntegers( const double a, const double b ) {
Expand Down
8 changes: 6 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/pow/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -377,9 +377,11 @@ static double pow2( uint32_t j, const double hp, const double lp ) {
* @param o2 destination for output2
*
* @example
* double o1;
* double o2;
* logx( 9.0, &o1, &o2 );
*/
void logx( const double ax, double *o1, double *o2 ) {
static void logx( const double ax, double *o1, double *o2 ) {
Comment thread
kgryte marked this conversation as resolved.
double t2;
double t1;
double t;
Expand Down Expand Up @@ -408,9 +410,11 @@ void logx( const double ax, double *o1, double *o2 ) {
* @param o2 destination for output2
*
* @example
* double o1;
* double o2;
* log2ax( 9.0, 1075970048, &o1, &o2 );
*/
void log2ax( const double ax, const int32_t ahx, double *o1, double *o2 ) {
static void log2ax( const double ax, const int32_t ahx, double *o1, double *o2 ) {
uint32_t ahxcc;
uint32_t tmp;
int32_t ahxc;
Expand Down
10 changes: 7 additions & 3 deletions lib/node_modules/@stdlib/math/base/special/powf/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ static float polyval_p( const float x ) {
*
* @example
* float out = y_is_infinitef( -1.0f, 1.0f/0.0f );
* // returns NaN
* // returns 1.0f
*/
static float y_is_infinitef( const float x, const float y ) {
if ( x == -1.0f ) {
Expand Down Expand Up @@ -328,9 +328,11 @@ static float pow2f( uint32_t j, const float hp, const float lp ) {
* @param o2 destination for output2
*
* @example
* float o1;
* float o2;
* logxf( 9.0f, &o1, &o2 );
*/
void logxf( const float ax, float *o1, float *o2 ) {
static void logxf( const float ax, float *o1, float *o2 ) {
uint32_t tmp;
float t2;
float t1;
Expand Down Expand Up @@ -361,9 +363,11 @@ void logxf( const float ax, float *o1, float *o2 ) {
* @param o2 destination for output2
*
* @example
* float o1;
* float o2;
* log2axf( 9.0f, 1075970048, &o1, &o2 );
*/
void log2axf( const float ax, const int32_t ahx, float *o1, float *o2 ) {
static void log2axf( const float ax, const int32_t ahx, float *o1, float *o2 ) {
uint32_t ahxcc;
uint32_t tmp;
int32_t ahxc;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* Enumeration of k-means clustering algorithms.
*/
enum STDLIB_ML_KMEANS_ALGORITHMS {
enum STDLIB_ML_KMEANS_ALGORITHM {
// Classic EM-style algorithm:
STDLIB_ML_KMEANS_LLOYD = 0,

Expand Down
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/every/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ void stdlib_ndarray_every_by_f_x_as_d_x(...) {...}

is a function which accepts one single-precision floating-point input ndarray and one boolean output ndarray. However, the callback accepts double-precision floating-point numbers. Accordingly, the input values need to be cast using the following conversion sequence

<!-- run-disable -->

```c
#include <stdbool.h>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* const int64_t shape[] = { 2, 3, 10 };
* int64_t out[ 2 ];
*
* stdlib_ndarray_flatten_shape( ndims, shape, 1, out );
* stdlib_ndarray_flatten_shape_from( ndims, shape, 1, out );
*/
int8_t stdlib_ndarray_flatten_shape_from( const int64_t ndims, const int64_t *shape, const int64_t dim, int64_t *out ) {
int64_t d;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ console.log( headerDir );

Structure for grouping ndarray function information.

<!-- run-disable -->

```c
struct ndarrayFunctionObject {
// ndarray function name:
Expand Down
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/nullary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,8 @@ void stdlib_ndarray_f_as_d(...) {...}

is a function which accepts one single-precision floating-point output ndarray. However, the callback returns double-precision floating-point numbers. Accordingly, the output values need to be cast using the following conversion sequence

<!-- run-disable -->

```c
// Evaluate the callback:
double out = f();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ void stdlib_ndarray_accumulate_ff_f_as_dd_d(...) {...}

is a function which performs accumulation in single-precision and accepts one single-precision floating-point input ndarray and one single-precision floating-point output ndarray. However, the callback accepts and returns double-precision floating-point numbers. Accordingly, the input and output values need to be cast using the following conversion sequence

<!-- run-disable -->

```c
// Convert the current accumulated value to double-precision:
double curr = (double)acc;
Expand Down
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/unary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,8 @@ void stdlib_ndarray_f_f_as_d_d(...) {...}

is a function which accepts one single-precision floating-point input ndarray and one single-precision floating-point output ndarray. However, the callback accepts and returns double-precision floating-point numbers. Accordingly, the input and output values need to be cast using the following conversion sequence

<!-- run-disable -->

```c
// Convert each input array element to double-precision:
double in1 = (double)x[ i ];
Expand Down
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/ndarray/ctor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -721,6 +721,8 @@ str = JSON.stringify( arr.toJSON() );

Structure holding ndarray data.

<!-- run-disable -->

```c
#include "stdlib/ndarray/dtypes.h"
#include "stdlib/ndarray/index_modes.h"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,8 @@ console.log( str );

Structure for holding single-precision floating-point test results.

<!-- run-disable -->

```c
#include <stdbool.h>
#include <stdint.h>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,8 @@ console.log( str );

Structure for holding double-precision floating-point test results.

<!-- run-disable -->

```c
#include <stdbool.h>
#include <stdint.h>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,8 @@ console.log( str );

Structure for holding single-precision floating-point test results.

<!-- run-disable -->

```c
#include <stdbool.h>
#include <stdint.h>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,8 @@ console.log( str );

Structure for holding double-precision floating-point test results.

<!-- run-disable -->

```c
#include <stdbool.h>
#include <stdint.h>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ console.log( headerDir );

Structure for grouping strided array function information.

<!-- run-disable -->

```c
struct StridedFunctionObject {
// Strided array function name:
Expand Down
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/strided/base/mskunary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,8 @@ stdlib_strided_mask_<input_data_type>_<output_data_type>[_as_<callback_arg_data_

For example,

<!-- run-disable -->

```c
void stdlib_strided_mask_d_d(...) {...}
```
Expand All @@ -232,12 +234,16 @@ is a function which accepts one double-precision floating-point strided input ar

To support callbacks whose input arguments and/or return values are of a different data type than the strided input and/or output array data types, the naming convention supports appending an `as` suffix. For example,

<!-- run-disable -->

```c
void stdlib_strided_mask_f_f_as_d_d(...) {...}
```

is a function which accepts one single-precision floating-point strided input array and one single-precision floating-point strided output array. However, the callback accepts and returns double-precision floating-point numbers. Accordingly, the input and output values need to be cast using the following conversion sequence

<!-- run-disable -->

```c
// Convert each input array element to double-precision:
double in1 = (double)x[ i ];
Expand Down
Loading
Loading