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!

Complex128Array

128-bit complex number array.

Installation

npm install @stdlib/array-complex128

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

varComplex128Array=require('@stdlib/array-complex128');

Complex128Array()

Creates a 128-bit complex number array.

vararr=newComplex128Array();// returns <Complex128Array>

Complex128Array( length )

Creates a 128-bit complex number array having a specified length.

vararr=newComplex128Array(10);// returns <Complex128Array>varlen=arr.length;// returns 10

Complex128Array( complexarray )

Creates a 128-bit complex number array from another complex number array.

vararr1=newComplex128Array([1.0,-1.0,2.0,-2.0]);// [ re, im, re, im ]// returns <Complex128Array>vararr2=newComplex128Array(arr1);// returns <Complex128Array>varlen=arr2.length;// returns 2

Complex128Array( typedarray )

Creates a 128-bit complex number array from a typed array containing interleaved real and imaginary components.

varFloat64Array=require('@stdlib/array-float64');varbuf=newFloat64Array([1.0,-1.0,2.0,-2.0]);// [ re, im, re, im ]// returns <Float64Array>[ 1.0, -1.0, 2.0, -2.0 ]vararr=newComplex128Array(buf);// returns <Complex128Array>varlen=arr.length;// returns 2

Complex128Array( obj )

Creates a 128-bit complex number array from an array-like object or iterable.

varComplex128=require('@stdlib/complex-float64-ctor');// From an array of interleaved real and imaginary components:vararr1=newComplex128Array([1.0,-1.0,2.0,-2.0]);// returns <Complex128Array>varlen=arr1.length;// returns 2// From an array containing complex numbers:varbuf=[newComplex128(1.0,-1.0),newComplex128(2.0,-2.0)];vararr2=newComplex128Array(buf);len=arr2.length;// returns 2

Complex128Array( buffer[, byteOffset[, length]] )

Returns a 128-bit complex number array view of an ArrayBuffer.

varArrayBuffer=require('@stdlib/array-buffer');varbuf=newArrayBuffer(480);vararr1=newComplex128Array(buf);// returns <Complex128Array>varlen=arr1.length;// returns 30vararr2=newComplex128Array(buf,16);// returns <Complex128Array>len=arr2.length;// returns 29vararr3=newComplex128Array(buf,16,20);// returns <Complex128Array>len=arr3.length;// returns 20

---

Properties

Complex128Array.BYTES_PER_ELEMENT

Static property returning the size (in bytes) of each array element.

varnbytes=Complex128Array.BYTES_PER_ELEMENT;// returns 16

Complex128Array.name

Static property returning the constructor name.

varstr=Complex128Array.name;// returns 'Complex128Array'

Complex128Array.prototype.buffer

Pointer to the underlying data buffer.

vararr=newComplex128Array(2);// returns <Complex128Array>varbuf=arr.buffer;// returns <ArrayBuffer>

Complex128Array.prototype.byteLength

Size (in bytes) of the array.

vararr=newComplex128Array(10);// returns <Complex128Array>varnbytes=arr.byteLength;// returns 160

Complex128Array.prototype.byteOffset

Offset (in bytes) of the array from the start of its underlying ArrayBuffer.

varArrayBuffer=require('@stdlib/array-buffer');vararr=newComplex128Array(10);// returns <Complex128Array>varoffset=arr.byteOffset;// returns 0varbuf=newArrayBuffer(480);arr=newComplex128Array(buf,128);// returns <Complex128Array>offset=arr.byteOffset;// returns 128

Complex128Array.prototype.BYTES_PER_ELEMENT

Size (in bytes) of each array element.

vararr=newComplex128Array(10);// returns <Complex128Array>varnbytes=arr.BYTES_PER_ELEMENT;// returns 16

Complex128Array.prototype.length

Number of array elements.

vararr=newComplex128Array(10);// returns <Complex128Array>varlen=arr.length;// returns 10

---

Methods

Complex128Array.from( src[, clbk[, thisArg]] )

Creates a new 128-bit complex number array from an array-like object or an iterable.

varComplex128=require('@stdlib/complex-float64-ctor');// Create an array from interleaved real and imaginary components:vararr=Complex128Array.from([1.0,-1.0]);// returns <Complex128Array>varlen=arr.length;// returns 1// Create an array from an array of complex numbers:arr=Complex128Array.from([newComplex128(1.0,-1.0)]);// returns <Complex128Array>len=arr.length;// returns 1

The iterator returned by an iterable must return either a complex number or an array-like object containing a real and imaginary component.

varITERATOR_SYMBOL=require('@stdlib/symbol-iterator');varFloat64Array=require('@stdlib/array-float64');variter;vararr;varlen;varre;varim;varz;// Define a function which returns an iterator protocol-compliant object...functioniterable(){varbuf=newFloat64Array(2);vari=0;return{'next': next};functionnext(){i+=1;if(i<3){// Reuse allocated memory...buf[0]=i;buf[1]=-i;return{'value': buf};}return{'done': true};}}if(ITERATOR_SYMBOL===null){console.error('Environment does not support iterables.');}else{// Create an iterable:iter={};iter[ITERATOR_SYMBOL]=iterable;// Generate a complex number array:arr=Complex128Array.from(iter);// returns <Complex128Array>len=arr.length;// returns 2z=arr.get(0);// returns <Complex128>[ 1.0, -1.0 ]}

To invoke a function for each src value, provide a callback function. If src is an iterable or an array-like object containing complex numbers, the callback must return either a complex number

varComplex128=require('@stdlib/complex-float64-ctor');varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionmap(z){returnnewComplex128(real(z)*2.0,imag(z)*2.0);}// Create a source array:varsrc=[newComplex128(1.0,-1.0)];// Create a new complex number array by scaling the source array:vararr=Complex128Array.from(src,map);// returns <Complex128Array>varlen=arr.length;// returns 1varz=arr.get(0);// returns <Complex128>[ 2.0, -2.0 ]

or an array-like object containing real and imaginary components

varFloat64Array=require('@stdlib/array-float64');varComplex128=require('@stdlib/complex-float64-ctor');varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');// Return a callback which reuses allocated memory...functionmapFcn(){varbuf=newFloat64Array(2);returnmap;functionmap(z){buf[0]=real(z)*2.0;buf[1]=imag(z)*2.0;returnbuf;}}// Create a source array:varsrc=[newComplex128(1.0,-1.0),newComplex128(2.0,-2.0)];// Create a new complex number array by scaling the source array:vararr=Complex128Array.from(src,mapFcn());// returns <Complex128Array>varlen=arr.length;// returns 2varz=arr.get(0);// returns <Complex128>[ 2.0, -2.0 ]z=arr.get(1);// returns <Complex128>[ 4.0, -4.0 ]

If src is an array-like object containing interleaved real and imaginary components, the callback is invoked for each component and should return the transformed component value.

varFloat64Array=require('@stdlib/array-float64');varComplex128=require('@stdlib/complex-float64-ctor');functionmap(v){returnv*2.0;}// Create a source array:varsrc=newFloat64Array([1.0,-1.0]);// Create a new complex number array by scaling the source array:vararr=Complex128Array.from(src,map);// returns <Complex128Array>varlen=arr.length;// returns 1varz=arr.get(0);// returns <Complex128>[ 2.0, -2.0 ]

A callback function is provided two arguments:

• value: source value.
• index: source index.

To set the callback execution context, provide a thisArg.

varComplex128=require('@stdlib/complex-float64-ctor');varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionmap(z){this.count+=1;returnnewComplex128(real(z)*2.0,imag(z)*2.0);}// Create a source array:varsrc=[newComplex128(1.0,-1.0),newComplex128(1.0,-1.0)];// Define an execution context:varctx={'count': 0};// Create a new complex number array by scaling the source array:vararr=Complex128Array.from(src,map,ctx);// returns <Complex128Array>varlen=arr.length;// returns 2varn=ctx.count;// returns 2

Complex128Array.of( element0[, element1[, ...elementN]] )

Creates a new 128-bit complex number array from a variable number of arguments.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=Complex128Array.of(1.0,-1.0,2.0,-2.0);// returns <Complex128Array>varlen=arr.length;// returns 2varz1=newComplex128(1.0,-1.0);varz2=newComplex128(2.0,-2.0);arr=Complex128Array.of(z1,z2);// returns <Complex128Array>len=arr.length;// returns 2

Complex128Array.prototype.at( i )

Returns an array element located at integer position (index) i, with support for both nonnegative and negative integer positions.

vararr=newComplex128Array(10);// Set the first, second, and last elements:arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([9.0,-9.0],9);// Get the first element:varz=arr.at(0);// returns <Complex128>[ 1.0, -1.0 ]// Get the last element:z=arr.at(-1);// returns <Complex128>[ 9.0, -9.0 ]

If provided an out-of-bounds index, the method returns undefined.

vararr=newComplex128Array(10);varz=arr.at(100);// returns undefinedz=arr.at(-100);// returns undefined

Complex128Array.prototype.copyWithin( target, start[, end] )

Copies a sequence of elements within the array starting at start and ending at end (non-inclusive) to the position starting at target.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(4);// Set the array elements:arr.set(newComplex128(1.0,-1.0),0);arr.set(newComplex128(2.0,-2.0),1);arr.set(newComplex128(3.0,-3.0),2);arr.set(newComplex128(4.0,-4.0),3);// Get the first array element:varz=arr.get(0);// returns <Complex128>[ 1.0, -1.0 ]// Get the second array element:z=arr.get(1);// returns <Complex128>[ 2.0, -2.0 ]// Copy the last two elements to the first two elements:arr.copyWithin(0,2);// Get the first array element:z=arr.get(0);// returns <Complex128>[ 3.0, -3.0 ]// Get the second array element:z=arr.get(1);// returns <Complex128>[ 4.0, -4.0 ]

By default, end equals the number of array elements (i.e., one more than the last array index). To limit the sequence length, provide an end argument.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(4);// Set the array elements:arr.set(newComplex128(1.0,-1.0),0);arr.set(newComplex128(2.0,-2.0),1);arr.set(newComplex128(3.0,-3.0),2);arr.set(newComplex128(4.0,-4.0),3);// Get the third array element:varz=arr.get(2);// returns <Complex128>[ 3.0, -3.0 ]// Get the last array element:z=arr.get(3);// returns <Complex128>[ 4.0, -4.0 ]// Copy the first two elements to the last two elements:arr.copyWithin(2,0,2);// Get the third array element:z=arr.get(2);// returns <Complex128>[ 1.0, -1.0 ]// Get the last array element:z=arr.get(3);// returns <Complex128>[ 2.0, -2.0 ]

When a target, start, and/or end index is negative, the respective index is determined relative to the last array element. The following example achieves the same behavior as the previous example:

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(4);// Set the array elements:arr.set(newComplex128(1.0,-1.0),0);arr.set(newComplex128(2.0,-2.0),1);arr.set(newComplex128(3.0,-3.0),2);arr.set(newComplex128(4.0,-4.0),3);// Get the third array element:varz=arr.get(2);// returns <Complex128>[ 3.0, -3.0 ]// Get the last array element:z=arr.get(3);// returns <Complex128>[ 4.0, -4.0 ]// Copy the first two elements to the last two elements using negative indices:arr.copyWithin(-2,-4,-2);// Get the third array element:z=arr.get(2);// returns <Complex128>[ 1.0, -1.0 ]// Get the last array element:z=arr.get(3);// returns <Complex128>[ 2.0, -2.0 ]

Complex128Array.prototype.entries()

Returns an iterator for iterating over array key-value pairs.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=[newComplex128(1.0,-1.0),newComplex128(2.0,-2.0),newComplex128(3.0,-3.0)];arr=newComplex128Array(arr);// Create an iterator:varit=arr.entries();// Iterate over the key-value pairs...varv=it.next().value;// returns [ 0, <Complex128>[ 1.0, -1.0 ] ]v=it.next().value;// returns [ 1, <Complex128>[ 2.0, -2.0 ] ]v=it.next().value;// returns [ 2, <Complex128>[ 3.0, -3.0 ] ]varbool=it.next().done;// returns true

Complex128Array.prototype.every( predicate[, thisArg] )

Returns a boolean indicating whether all elements pass a test.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v){return(real(v)===imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);// Check whether all elements pass a test:varbool=arr.every(predicate);// returns true

The predicate function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

functionpredicate(v,i){this.count+=1;return(i>=0);}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varbool=arr.every(predicate,context);// returns truevarcount=context.count;// returns 3

Complex128Array.prototype.fill( value[, start[, end]] )

Returns a modified typed array filled with a fill value.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(3);// Set all elements to the same value:arr.fill(newComplex128(1.0,1.0));varz=arr.get(0);// returns <Complex128>[ 1.0, 1.0 ]z=arr.get(2);// returns <Complex128>[ 1.0, 1.0 ]// Fill all elements starting from the second element:arr.fill(newComplex128(2.0,2.0),1);z=arr.get(1);// returns <Complex128>[ 2.0, 2.0 ]z=arr.get(2);// returns <Complex128>[ 2.0, 2.0 ]// Fill all elements from first element until the second-to-last element:arr.fill(newComplex128(3.0,3.0),0,2);z=arr.get(0);// returns <Complex128>[ 3.0, 3.0 ]z=arr.get(1);// returns <Complex128>[ 3.0, 3.0 ]

When a start and/or end index is negative, the respective index is determined relative to the last array element.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(3);// Set all array elements, except the last element, to the same value:arr.fill(newComplex128(1.0,1.0),0,-1);varz=arr.get(0);// returns <Complex128>[ 1.0, 1.0 ]z=arr.get(arr.length-1);// returns <Complex128>[ 0.0, 0.0 ]

Complex128Array.prototype.filter( predicate[, thisArg] )

Returns a new array containing the elements of an array which pass a test implemented by a predicate function.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v){return(real(v)===imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,-3.0],2);varout=arr.filter(predicate);// returns <Complex128Array>varlen=out.length;// returns 1varz=out.get(0);// returns <Complex128>[ 2.0, 2.0 ]

The predicate function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v,i){this.count+=1;return(i>=0&&real(v)===imag(v));}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varout=arr.filter(predicate,context);// returns <Complex128Array>varlen=out.length;// returns 2varcount=context.count;// returns 3

Complex128Array.prototype.find( predicate[, thisArg] )

Returns the first element in an array for which a predicate function returns a truthy value.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v){return(real(v)===imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varz=arr.find(predicate);// returns <Complex128>[ 1.0, 1.0 ]

The predicate function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v,i){this.count+=1;return(i>=0&&real(v)===imag(v));}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varz=arr.find(predicate,context);// returns <Complex128>[ 2.0, 2.0 ]varcount=context.count;// returns 2

Complex128Array.prototype.findIndex( predicate[, thisArg] )

Returns the index of the first element in an array for which a predicate function returns a truthy value.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v){return(real(v)===imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,3.0],2);varidx=arr.findIndex(predicate);// returns 2

The predicate function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v,i){this.count+=1;return(i>=0&&real(v)===imag(v));}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,-3.0],2);varidx=arr.findIndex(predicate,context);// returns -1varcount=context.count;// returns 3

Complex128Array.prototype.findLast( predicate[, thisArg] )

Returns the last element in an array for which a predicate function returns a truthy value.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v){return(real(v)===imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varz=arr.findLast(predicate);// returns <Complex128>[ 3.0, 3.0 ]

The predicate function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v,i){this.count+=1;return(i>=0&&real(v)===imag(v));}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,-3.0],2);varz=arr.findLast(predicate,context);// returns <Complex128>[ 2.0, 2.0 ]varcount=context.count;// returns 2

Complex128Array.prototype.findLastIndex( predicate[, thisArg] )

Returns the index of the last element in an array for which a predicate function returns a truthy value.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v){return(real(v)===imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,-3.0],2);varidx=arr.findLastIndex(predicate);// returns 1

The predicate function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v,i){this.count+=1;return(i>=0&&real(v)===imag(v));}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,-3.0],2);varidx=arr.findLastIndex(predicate,context);// returns -1varcount=context.count;// returns 3

Complex128Array.prototype.forEach( callbackFn[, thisArg] )

Invokes a function once for each array element.

varComplex128=require('@stdlib/complex-float64-ctor');functionlog(v,i){console.log('%s: %s',i,v.toString());}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);arr.forEach(log);/* => 0: 1 + 1i 1: 2 + 2i 2: 3 + 3i*/

The invoked function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varComplex128=require('@stdlib/complex-float64-ctor');functionfcn(v,i){this.count+=1;console.log('%s: %s',i,v.toString());}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,-3.0],2);arr.forEach(fcn,context);/* => 0: 1 + 1i 1: 2 + 2i 2: 3 + 3i*/varcount=context.count;// returns 3

Complex128Array.prototype.get( i )

Returns an array element located at position (index) i.

vararr=newComplex128Array(10);// Set the first element:arr.set([1.0,-1.0],0);// Get the first element:varz=arr.get(0);// returns <Complex128>[ 1.0, -1.0 ]

If provided an out-of-bounds index, the method returns undefined.

vararr=newComplex128Array(10);varz=arr.get(100);// returns undefined

Complex128Array.prototype.includes( searchElement[, fromIndex] )

Returns a boolean indicating whether an array includes a provided value.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(5);arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,-3.0],2);arr.set([4.0,-4.0],3);arr.set([5.0,-5.0],4);varbool=arr.includes(newComplex128(3.0,-3.0));// returns truebool=arr.includes(newComplex128(3.0,-3.0),3);// returns falsebool=arr.includes(newComplex128(4.0,-4.0),-3);// returns true

Complex128Array.prototype.indexOf( searchElement[, fromIndex] )

Returns the first index at which a given element can be found.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(5);arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,-3.0],2);arr.set([4.0,-4.0],3);arr.set([2.0,-2.0],4);varidx=arr.indexOf(newComplex128(3.0,-3.0));// returns 2idx=arr.indexOf(newComplex128(2.0,-2.0),2);// returns 4idx=arr.indexOf(newComplex128(4.0,-4.0),-3);// returns 3

If searchElement is not present in the array, the method returns -1.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(5);arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);varidx=arr.indexOf(newComplex128(3.0,-3.0));// returns -1idx=arr.indexOf(newComplex128(1.0,-1.0),1);// returns -1

Complex128Array.prototype.join( [separator] )

Returns a new string by concatenating all array elements.

vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,3.0],2);varstr=arr.join();// returns '1 + 1i,2 - 2i,3 + 3i'

By default, the method separates serialized array elements with a comma. To use an alternative separator, provide a separator string.

vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,3.0],2);varstr=arr.join('/');// returns '1 + 1i/2 - 2i/3 + 3i'

Complex128Array.prototype.keys()

Returns an iterator for iterating over each index key in a typed array.

vararr=newComplex128Array(2);arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);variter=arr.keys();varv=iter.next().value;// returns 0v=iter.next().value;// returns 1varbool=iter.next().done;// returns true

The returned iterator protocol-compliant object has the following properties:

• next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
• return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

Complex128Array.prototype.lastIndexOf( searchElement[, fromIndex] )

Returns the last index at which a given element can be found.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(5);arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,-3.0],2);arr.set([4.0,-4.0],3);arr.set([2.0,-2.0],4);varidx=arr.lastIndexOf(newComplex128(3.0,-3.0));// returns 2idx=arr.lastIndexOf(newComplex128(2.0,-2.0),2);// returns 1idx=arr.lastIndexOf(newComplex128(4.0,-4.0),-1);// returns 3

If searchElement is not present in the array, the method returns -1.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(5);arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);varidx=arr.lastIndexOf(newComplex128(3.0,-3.0));// returns -1idx=arr.lastIndexOf(newComplex128(2.0,-2.0),0);// returns -1

Complex128Array.prototype.map( callbackFn[, thisArg] )

Returns a new array with each element being the result of a provided callback function.

varComplex128=require('@stdlib/complex-float64-ctor');varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionscale(v){returnnewComplex128(2.0*real(v),2.0*imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,-3.0],2);varout=arr.map(scale);// returns <Complex128Array>[ 2.0, -2.0, 4.0, -4.0, 6.0, -6.0 ]

The callback function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varComplex128=require('@stdlib/complex-float64-ctor');varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionscale(v){this.count+=1;returnnewComplex128(2.0*real(v),2.0*imag(v));}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varout=arr.map(scale,context);// returns <Complex128Array>varcount=context.count;// returns 3

Complex128Array.prototype.reduce( reducerFn[, initialValue] )

Applies a provided callback function to each element of the array, in order, passing in the return value from the calculation on the preceding element and returning the accumulated result upon completion.

varcadd=require('@stdlib/complex-float64-base-add');vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varz=arr.reduce(cadd);// returns <Complex128>[ 6.0, 6.0 ]

The reducer function is provided four arguments:

• acc: accumulated result.
• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

By default, the function initializes the accumulated result to the first element in the array and passes the second array element as value during the first invocation of the provided callback. To begin accumulation from a different starting value and pass in the first array element as value during the first invocation of the provided callback, provide an initialValue argument.

varreal=require('@stdlib/complex-float64-real');functionreducer(acc,v){acc+=real(v);returnacc;}vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varz=arr.reduce(reducer,0.0);// returns 6.0

Complex128Array.prototype.reduceRight( reducerFn[, initialValue] )

Applies a provided callback function to each element of the array, in reverse order, passing in the return value from the calculation on the following element and returning the accumulated result upon completion.

varcadd=require('@stdlib/complex-float64-base-add');vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varz=arr.reduceRight(cadd);// returns <Complex128>[ 6.0, 6.0 ]

The reducer function is provided four arguments:

• acc: accumulated result.
• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

By default, the function initializes the accumulated result to the last element in the array and passes the second-last array element as value during the first invocation of the provided callback. To begin accumulation from a different starting value and pass in the last array element as value during the first invocation of the provided callback, provide an initialValue argument.

varreal=require('@stdlib/complex-float64-real');functionreducer(acc,v){acc+=real(v);returnacc;}vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varz=arr.reduceRight(reducer,0.0);// returns 6.0

Complex128Array.prototype.reverse()

Reverses an array in-place.

vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varout=arr.reverse();// returns <Complex128Array>[ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ]

Complex128Array.prototype.set( z[, i] )

Sets one or more array elements.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(10);// Get the first element:varz=arr.get(0);// returns <Complex128>[ 0.0, 0.0 ]// Set the first element:arr.set(newComplex128(1.0,-1.0));// Get the first element:z=arr.get(0);// returns <Complex128>[ 1.0, -1.0 ]

By default, the method sets array elements starting at position (index) i = 0. To set elements starting elsewhere in the array, provide an index argument i.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(10);// Get the fifth element:varz=arr.get(4);// returns <Complex128>[ 0.0, 0.0 ]// Set the fifth element:arr.set(newComplex128(1.0,-1.0),4);// Get the fifth element:z=arr.get(4);// returns <Complex128>[ 1.0, -1.0 ]

In addition to providing a complex number, to set one or more array elements, provide an array-like object containing either complex numbers

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(10);// Define an array of complex numbers:varbuf=[newComplex128(1.0,-1.0),newComplex128(2.0,-2.0),newComplex128(3.0,-3.0)];// Set the fifth, sixth, and seventh elements:arr.set(buf,4);// Get the sixth element:varz=arr.get(5);// returns <Complex128>[ 2.0, -2.0 ]

or interleaved real and imaginary components

varFloat64Array=require('@stdlib/array-float64');vararr=newComplex128Array(10);// Define an interleaved array of real and imaginary components:varbuf=newFloat64Array([1.0,-1.0,2.0,-2.0,3.0,-3.0]);// Set the fifth, sixth, and seventh elements:arr.set(buf,4);// Get the sixth element:varz=arr.get(5);// returns <Complex128>[ 2.0, -2.0 ]

A few notes:

• If i is out-of-bounds, the method throws an error.
• If a target array cannot accommodate all values (i.e., the length of source array plus i exceeds the target array length), the method throws an error.
• If provided a typed array which shares an ArrayBuffer with the target array, the method will intelligently copy the source range to the destination range.

Complex128Array.prototype.slice( [start[, end]] )

Copies a portion of a typed array to a new typed array.

vararr=newComplex128Array([1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0]);varout=arr.slice();// returns <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]varlen=out.length;// returns 4

By default, the method returns a typed array beginning with the first array element. To specify an alternative array index at which to begin, provide a start index (inclusive).

vararr=newComplex128Array([1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0]);varout=arr.slice(1);// returns <Complex128Array>[ 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]varlen=out.length;// returns 3

By default, the method returns a typed array which includes all array elements after start. To limit the number of array elements after start, provide an end index (exclusive).

vararr=newComplex128Array([1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0]);varout=arr.slice(1,-1);// returns <Complex128Array>[ 3.0, 4.0, 5.0, 6.0 ]varlen=out.length;// returns 2

Complex128Array.prototype.some( predicate[, thisArg] )

Returns a boolean indicating whether at least one element passes a test.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v){return(real(v)===imag(v));}vararr=newComplex128Array(3);// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,-3.0],2);// Check whether at least one element passes a test:varbool=arr.some(predicate);// returns true

The predicate function is provided three arguments:

• value: current array element.
• index: current array element index.
• arr: the array on which this method was called.

To set the function execution context, provide a thisArg.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functionpredicate(v,i){this.count+=1;return(imag(v)===real(v));}vararr=newComplex128Array(3);varcontext={'count': 0};// Set the first three elements:arr.set([1.0,-1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,-3.0],2);varbool=arr.some(predicate,context);// returns truevarcount=context.count;// returns 2

Complex128Array.prototype.sort( compareFcn )

Sorts an array in-place.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functioncompare(a,b){varre1;varre2;varim1;varim2;re1=real(a);re2=real(b);if(re1<re2){return-1;}if(re1>re2){return1;}im1=imag(a);im2=imag(b);if(im1<im2){return-1;}if(im1>im2){return1;}return0;}vararr=newComplex128Array(3);arr.set([3.0,-3.0],0);arr.set([1.0,-1.0],1);arr.set([2.0,-2.0],2);varout=arr.sort(compare);// returns <Complex128Array>[ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ]

The compareFcn determines the order of the elements. The function is called with the following arguments:

• a: the first element for comparison.
• b: the second element for comparison.

The function should return a number where:

• a negative value indicates that a should come before b.
• a positive value indicates that a should come after b.
• zero or NaN indicates that a and b are considered equal.

In contrast to real numbers, one cannot define a default order relation which is compatible with multiplication. Accordingly, users must explicitly provide a compareFcn argument and are thus responsible for specifying a complex number ordering.

Complex128Array.prototype.subarray( [begin[, end]] )

Creates a new typed array view over the same underlying ArrayBuffer and with the same underlying data type as the host array.

vararr=newComplex128Array([1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0]);varsubarr=arr.subarray();// returns <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]varlen=subarr.length;// returns 4

By default, the method creates a typed array view beginning with the first array element. To specify an alternative array index at which to begin, provide a begin index (inclusive).

vararr=newComplex128Array([1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0]);varsubarr=arr.subarray(1);// returns <Complex128Array>[ 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]varlen=subarr.length;// returns 3

By default, the method creates a typed array view which includes all array elements after begin. To limit the number of array elements after begin, provide an end index (exclusive).

vararr=newComplex128Array([1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0]);varsubarr=arr.subarray(1,-1);// returns <Complex128Array>[ 3.0, 4.0, 5.0, 6.0 ]varlen=subarr.length;// returns 2

Complex128Array.prototype.toLocaleString( [locales[, options]] )

Serializes an array as a locale-specific string.

vararr=newComplex128Array(2);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);varstr=arr.toLocaleString();// returns '1 + 1i,2 + 2i'

The method supports the following arguments:

• locales: a string with a BCP 47 language tag or an array of such strings.
• options: configuration properties.

Complex128Array.prototype.toReversed()

Returns a new typed array containing the elements in reversed order.

vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varout=arr.toReversed();// returns <Complex128Array>[ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ]

Complex128Array.prototype.toSorted( compareFcn )

Returns a new typed array containing the elements in sorted order.

varreal=require('@stdlib/complex-float64-real');varimag=require('@stdlib/complex-float64-imag');functioncompare(a,b){varre1;varre2;varim1;varim2;re1=real(a);re2=real(b);if(re1<re2){return-1;}if(re1>re2){return1;}im1=imag(a);im2=imag(b);if(im1<im2){return-1;}if(im1>im2){return1;}return0;}vararr=newComplex128Array(3);arr.set([3.0,-3.0],0);arr.set([1.0,-1.0],1);arr.set([2.0,-2.0],2);varout=arr.toSorted(compare);// returns <Complex128Array>[ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ]

The compareFcn determines the order of the elements. The function is called with the following arguments:

• a: the first element for comparison.
• b: the second element for comparison.

The function should return a number where:

• a negative value indicates that a should come before b.
• a positive value indicates that a should come after b.
• zero or NaN indicates that a and b are considered equal.

In contrast to real numbers, one cannot define a default order relation which is compatible with multiplication. Accordingly, users must explicitly provide a compareFcn argument and are thus responsible for specifying a complex number ordering.

Complex128Array.prototype.toString()

Serializes an array as a string.

vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,-2.0],1);arr.set([3.0,3.0],2);varstr=arr.toString();// returns '1 + 1i,2 - 2i,3 + 3i'

Complex128Array.prototype.values()

Returns an iterator for iterating over each value in a typed array.

vararr=newComplex128Array(2);arr.set([1.0,-1.0],0);arr.set([2.0,-2.0],1);variter=arr.values();varv=iter.next().value;// returns <Complex128>[ 1.0, -1.0 ]v=iter.next().value;// returns <Complex128>[ 2.0, -2.0 ]varbool=iter.next().done;// returns true

The returned iterator protocol-compliant object has the following properties:

• next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
• return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

Complex128Array.prototype.with( index, value )

Returns a new typed array with the element at a provided index replaced with a provided value.

varComplex128=require('@stdlib/complex-float64-ctor');vararr=newComplex128Array(3);arr.set([1.0,1.0],0);arr.set([2.0,2.0],1);arr.set([3.0,3.0],2);varout=arr.with(0,newComplex128(4.0,4.0));// returns <Complex128Array>[ 4.0, 4.0, 2.0, 2.0, 3.0, 3.0 ]

---

Notes

• While a Complex128Arraystrives to maintain (but does not guarantee) consistency with typed arrays, significant deviations from ECMAScript-defined typed array behavior are as follows:

  • The constructor does not require the new operator.
  • The constructor and associated methods support a broader variety of input argument types in order to better accommodate complex number input.
  • Accessing array elements using bracket syntax (e.g., Z[i]) is not supported. Instead, one must use the .get() method which returns a value compatible with complex number output.
  • The set method has extended behavior in order to support complex numbers.

---

Examples

varComplex128=require('@stdlib/complex-float64-ctor');varFloat64Array=require('@stdlib/array-float64');varlogEach=require('@stdlib/console-log-each');varComplex128Array=require('@stdlib/array-complex128');// Create a complex array by specifying a length:varout=newComplex128Array(3);logEach('%s',out);// Create a complex array from an array of complex numbers:vararr=[newComplex128(1.0,-1.0),newComplex128(-3.14,3.14),newComplex128(0.5,0.5)];out=newComplex128Array(arr);logEach('%s',out);// Create a complex array from an interleaved typed array:arr=newFloat64Array([1.0,-1.0,-3.14,3.14,0.5,0.5]);out=newComplex128Array(arr);logEach('%s',out);// Create a complex array from an array buffer:arr=newFloat64Array([1.0,-1.0,-3.14,3.14,0.5,0.5]);out=newComplex128Array(arr.buffer);logEach('%s',out);// Create a complex array from an array buffer view:arr=newFloat64Array([1.0,-1.0,-3.14,3.14,0.5,0.5]);out=newComplex128Array(arr.buffer,16,2);logEach('%s',out);

---

See Also

• @stdlib/array-complex64: Complex64Array.
• @stdlib/complex-cmplx: create a complex number.
• @stdlib/complex-float64/ctor: 128-bit complex number.

---

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.