npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stdlib/math-strided-special-acoth-by

v0.2.2

Published

Compute the inverse hyperbolic cotangent of each element retrieved from an input strided array via a callback function.

Downloads

30

Readme

acothBy

NPM version Build Status Coverage Status

Compute the inverse hyperbolic cotangent of each element retrieved from an input strided array via a callback function.

Installation

npm install @stdlib/math-strided-special-acoth-by

Usage

var acothBy = require( '@stdlib/math-strided-special-acoth-by' );

acothBy( N, x, strideX, y, strideY, clbk[, thisArg] )

Computes the inverse hyperbolic cotangent of each element retrieved from an input strided array x via a callback function and assigns each result to an element in an output strided array y.

function accessor( v ) {
    return v;
}

var x = [ -5.0, -4.0, -3.0, -1.0, 1.0 ];
var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];

acothBy( x.length, x, 1, y, 1, accessor );
// y => [ ~-0.203, ~-0.255, ~-0.347, -Infinity, Infinity ]

The function accepts the following arguments:

  • N: number of indexed elements.
  • x: input Array, typed array, or an array-like object (excluding strings and functions).
  • strideX: index increment for x.
  • y: output Array, typed array, or an array-like object (excluding strings and functions).
  • strideY: index increment for y.
  • clbk: callback function.
  • thisArg: execution context (optional).

The invoked callback function is provided six arguments:

  • value: input array element.
  • idx: iteration index (zero-based).
  • xi: input array strided index (offsetX + idx*strideX).
  • yi: output array strided index (offsetY + idx*strideY).
  • x: input array/collection.
  • y: output array/collection.

To set the callback execution context, provide a thisArg.

function accessor( v ) {
    this.count += 1;
    return v;
}

var context = {
    'count': 0
};

var x = [ -5.0, -4.0, -3.0, -1.0, 1.0 ];
var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];

acothBy( x.length, x, 1, y, 1, accessor, context );
// y => [ ~-0.203, ~-0.255, ~-0.347, -Infinity, Infinity ]

var cnt = context.count;
// returns 5

The N and stride parameters determine which elements in x and y are accessed at runtime. For example, to index every other value in x and to index the first N elements of y in reverse order,

function accessor( v ) {
    return v;
}

var x = [ -5.0, -4.0, -3.0, -1.0, 1.0, 2.0 ];
var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

acothBy( 3, x, 2, y, -1, accessor );
// y => [ Infinity, ~-0.347, ~-0.203, 0.0, 0.0, 0.0 ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float64Array = require( '@stdlib/array-float64' );

function accessor( v ) {
    return v;
}

// Initial arrays...
var x0 = new Float64Array( [ -5.0, -4.0, -3.0, -1.0, 1.0, 2.0 ] );
var y0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

// Create offset views...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element

acothBy( 3, x1, -2, y1, 1, accessor );
// y0 => <Float64Array>[ 0.0, 0.0, 0.0, ~0.549, -Infinity, ~-0.255 ]

acothBy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, clbk[, thisArg] )

Computes the inverse hyperbolic cotangent of each element retrieved from an input strided array x via a callback function and assigns each result to an element in an output strided array y using alternative indexing semantics.

function accessor( v ) {
    return v;
}

var x = [ -5.0, -4.0, -3.0, -1.0, 1.0 ];
var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];

acothBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor );
// y => [ ~-0.203, ~-0.255, ~-0.347, -Infinity, Infinity ]

The function accepts the following additional arguments:

  • offsetX: starting index for x.
  • offsetY: starting index for y.

While typed array views mandate a view offset based on the underlying buffer, the offsetX and offsetY parameters support indexing semantics based on starting indices. For example, to index every other value in x starting from the second value and to index the last N elements in y,

function accessor( v ) {
    return v;
}

var x = [ -5.0, -4.0, -3.0, -1.0, 1.0, 2.0 ];
var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];

acothBy.ndarray( 3, x, 2, 1, y, -1, y.length-1, accessor );
// y => [ 0.0, 0.0, 0.0, ~0.549, -Infinity, ~-0.255 ]

Notes

  • If a provided callback function does not return any value (or equivalently, explicitly returns undefined), the value is ignored.

    function accessor() {
        // No-op...
    }
    
    var x = [ -5.0, -4.0, -3.0, -1.0, 1.0 ];
    var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
    
    acothBy( x.length, x, 1, y, 1, accessor );
    // y => [ 0.0, 0.0, 0.0, 0.0, 0.0 ]

Examples

var uniform = require( '@stdlib/random-base-uniform' ).factory;
var filledarray = require( '@stdlib/array-filled' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
var acothBy = require( '@stdlib/math-strided-special-acoth-by' );

function accessor( v, i ) {
    if ( (i%3) === 0 ) {
        // Simulate a "missing" value...
        return;
    }
    return v;
}

var x = filledarrayBy( 10, 'generic', uniform( 1.0, 5.0 ) );
console.log( x );

var y = filledarray( null, 10, 'generic' );
console.log( y );

acothBy.ndarray( x.length, x, 1, 0, y, -1, y.length-1, accessor );
console.log( y );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.