https://github.com/stdlib-js/blas-base-dcabs1

Compute the sum of the absolute values of the real and imaginary components of a double-precision complex floating-point number.
https://github.com/stdlib-js/blas-base-dcabs1

abs absolute blas cmplx complex dcabs1 float64 javascript math mathematics node node-js nodejs number scalar stdlib

Last synced: 6 days ago
JSON representation

Compute the sum of the absolute values of the real and imaginary components of a double-precision complex floating-point number.

Host: GitHub
URL: https://github.com/stdlib-js/blas-base-dcabs1
Owner: stdlib-js
License: apache-2.0
Created: 2024-06-07T01:44:18.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-11-01T09:58:05.000Z (6 months ago)
Last Synced: 2024-11-11T05:53:33.626Z (6 months ago)
Topics: abs, absolute, blas, cmplx, complex, dcabs1, float64, javascript, math, mathematics, node, node-js, nodejs, number, scalar, stdlib
Language: Python
Homepage: https://github.com/stdlib-js/stdlib
Size: 158 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md

Awesome Lists containing this project

README

        

  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

  The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

  When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

  To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!


# dcabs1

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> Compute the sum of the [absolute values][absolute-value] of the real part and imaginary components of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.

## Installation

```bash

npm install @stdlib/blas-base-dcabs1

```

Alternatively,

-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage

```javascript

var dcabs1 = require( '@stdlib/blas-base-dcabs1' );

```

#### dcabs1( z )

Computes the sum of the [absolute values][absolute-value] of the real part and imaginary components of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.

```javascript

var Complex128 = require( '@stdlib/complex-float64-ctor' );

var y = dcabs1( new Complex128( 5.0, -3.0 ) );

// returns 8.0

```

## Examples

```javascript

var Complex128 = require( '@stdlib/complex-float64-ctor' );

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );

var dcabs1 = require( '@stdlib/blas-base-dcabs1' );

var z;

var i;

for ( i = 0; i < 100; i++ ) {

    z = new Complex128( discreteUniform( -5, 5 ), discreteUniform( -5, 5 ) );

    console.log( 'dcabs1(%s) = %d', z.toString(), dcabs1( z ) );

}

```

* * *

## C APIs

### Usage

```c

#include "stdlib/blas/base/dcabs1.h"

```

#### c_dcabs1( z )

Computes the sum of the [absolute values][absolute-value] of the real and imaginary components of a double-precision [complex][@stdlib/complex/float64/ctor] floating-point number.

```c

#include "stdlib/complex/float64/ctor.h"

const stdlib_complex128_t c = stdlib_complex128( 5.0, -3.0 );

double y = c_dcabs1( z );

// returns 8.0

```

The function accepts the following arguments:

-   **z**: `[in] stdlib_complex128_t` complex number.

```c

double c_dcabs1( const stdlib_complex128_t z );

```

### Examples

```c

#include "stdlib/blas/base/dcabs1.h"

#include "stdlib/complex/float64/ctor.h"

#include "stdlib/complex/float64/real.h"

#include "stdlib/complex/float64/imag.h"

#include 

int main( void ) {

    const stdlib_complex128_t x[] = {

        stdlib_complex128( 3.14, 1.0 ),

        stdlib_complex128( -3.14, -1.0 ),

        stdlib_complex128( 0.0, 0.0 ),

        stdlib_complex128( 0.0/0.0, 0.0/0.0 )

    };

    float y;

    int i;

    for ( i = 0; i < 4; i++ ) {

        y = c_dcabs1( x[ i ] );

        printf( "f(%lf + %lf) = %lf\n", stdlib_complex128_real( x[ i ] ), stdlib_complex128_imag( x[ i ] ), y );

    }

}

```

* * *

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/blas-base-dcabs1.svg

[npm-url]: https://npmjs.org/package/@stdlib/blas-base-dcabs1

[test-image]: https://github.com/stdlib-js/blas-base-dcabs1/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/blas-base-dcabs1/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-base-dcabs1/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/blas-base-dcabs1?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/blas-base-dcabs1/tree/deno

[deno-readme]: https://github.com/stdlib-js/blas-base-dcabs1/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/blas-base-dcabs1/tree/umd

[umd-readme]: https://github.com/stdlib-js/blas-base-dcabs1/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/blas-base-dcabs1/tree/esm

[esm-readme]: https://github.com/stdlib-js/blas-base-dcabs1/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/blas-base-dcabs1/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-base-dcabs1/main/LICENSE

[absolute-value]: https://en.wikipedia.org/wiki/Absolute_value

[@stdlib/complex/float64/ctor]: https://github.com/stdlib-js/complex-float64-ctor

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/stdlib-js/blas-base-dcabs1

Awesome Lists containing this project

README