/*
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/* eslint-disable max-lines */

import add = require( '@stdlib/complex-float64-base-add' );
import add3 = require( '@stdlib/complex-float64-base-add3' );
import assert = require( '@stdlib/complex-float64-base-assert' );
import div = require( '@stdlib/complex-float64-base-div' );
import identity = require( '@stdlib/complex-float64-base-identity' );
import mul = require( '@stdlib/complex-float64-base-mul' );
import muladd = require( '@stdlib/complex-float64-base-mul-add' );
import neg = require( '@stdlib/complex-float64-base-neg' );
import scale = require( '@stdlib/complex-float64-base-scale' );
import sub = require( '@stdlib/complex-float64-base-sub' );

/**
* Interface describing the `base` namespace.
*/
interface Namespace {
	/**
	* Adds two double-precision complex floating-point numbers.
	*
	* @param z1 - complex number
	* @param z2 - complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z = new Complex128( 5.0, 3.0 );
	*
	* var out = ns.add( z, z );
	* // returns <Complex128>[ 10.0, 6.0 ]
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var out = new Float64Array( 2 );
	* var v = ns.add.assign( 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
	* // returns <Float64Array>[ 10.0, 6.0 ]
	*
	* var bool = ( out === v );
	* // returns true
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var z1 = new Float64Array( [ 5.0, 3.0 ] );
	* var z2 = new Float64Array( [ 5.0, 3.0 ] );
	*
	* var out = ns.add.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
	* // returns <Float64Array>[ 10.0, 6.0 ]
	*/
	add: typeof add;

	/**
	* Computes the sum of three double-precision complex floating-point numbers.
	*
	* @param z1 - first complex number
	* @param z2 - second complex number
	* @param z3 - third complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z = new Complex128( 5.0, 3.0 );
	*
	* var out = ns.add3( z, z, z );
	* // returns <Complex128>[ 15.0, 9.0 ]
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var out = new Float64Array( 2 );
	* var v = ns.add3.assign( 5.0, 3.0, 5.0, 3.0, 5.0, 3.0, out, 1, 0 );
	* // returns <Float64Array>[ 15.0, 9.0 ]
	*
	* var bool = ( out === v );
	* // returns true
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var z1 = new Float64Array( [ 5.0, 3.0 ] );
	* var z2 = new Float64Array( [ 5.0, 3.0 ] );
	* var z3 = new Float64Array( [ 5.0, 3.0 ] );
	*
	* var out = ns.add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, new Float64Array( 2 ), 1, 0 );
	* // returns <Float64Array>[ 15.0, 9.0 ]
	*/
	add3: typeof add3;

	/**
	* Base (i.e., lower-level) double-precision complex number assertion functions.
	*/
	assert: typeof assert;

	/**
	* Divides two double-precision complex floating-point numbers.
	*
	* @param z1 - complex number
	* @param z2 - complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z1 = new Complex128( -13.0, -1.0 );
	* var z2 = new Complex128( -2.0, 1.0 );
	*
	* var out = ns.div( z1, z2 );
	* // returns <Complex128>[ 5.0, 3.0 ]
	*/
	div: typeof div;

	/**
	* Evaluates the identity function for double-precision complex floating-point number.
	*
	* @param z - input value
	* @returns input value
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var v = ns.identity( new Complex128( -1.0, 2.0 ) );
	* // returns <Complex128>[ -1.0, 2.0 ]
	*/
	identity: typeof identity;

	/**
	* Multiplies two double-precision complex floating-point numbers.
	*
	* @param z1 - complex number
	* @param z2 - complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z1 = new Complex128( 5.0, 3.0 );
	* var z2 = new Complex128( -2.0, 1.0 );
	*
	* var out = ns.mul( z1, z2 );
	* // returns <Complex128>[ -13.0, -1.0 ]
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var out = new Float64Array( 2 );
	* var v = ns.mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
	* // returns <Float64Array>[ -13.0, -1.0 ]
	*
	* var bool = ( out === v );
	* // returns true
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var z1 = new Float64Array( [ 5.0, 3.0 ] );
	* var z2 = new Float64Array( [ -2.0, 1.0 ] );
	*
	* var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
	* // returns <Float64Array>[ -13.0, -1.0 ]
	*/
	mul: typeof mul;

	/**
	* Performs a multiply-add operation involving three double-precision complex floating-point numbers.
	*
	* @param alpha - complex number
	* @param x - complex number
	* @param y - complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z1 = new Complex128( 5.0, 3.0 );
	* var z2 = new Complex128( -2.0, 1.0 );
	* var z3 = new Complex128( 7.0, -8.0 );
	*
	* var out = ns.muladd( z1, z2, z3 );
	* // returns <Complex128>[ -6.0, -9.0 ]
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var out = ns.muladd.assign( 5.0, 3.0, -2.0, 1.0, 7.0, -8.0, new Float64Array( 2 ), 1, 0 );
	* // returns <Float64Array>[ -6.0, -9.0 ]
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var alpha = new Float64Array( [ 5.0, 3.0 ] );
	* var x = new Float64Array( [ -2.0, 1.0 ] );
	* var y = new Float64Array( [ 7.0, -8.0 ] );
	*
	* var out = ns.muladd.strided( alpha, 1, 0, x, 1, 0, y, 1, 0, new Float64Array( 2 ), 1, 0 );
	* // returns <Float64Array>[ -6.0, -9.0 ]
	*/
	muladd: typeof muladd;

	/**
	* Negates a double-precision complex floating-point number.
	*
	* @param z - complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z1 = new Complex128( -4.2, 5.5 );
	*
	* var out = ns.neg( z1 );
	* // returns <Complex128>[ 4.2, -5.5 ]
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z2 = new Complex128( 0.0, 0.0 );
	*
	* var out = ns.neg( z2 );
	* // returns <Complex128>[ -0.0, -0.0 ]
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z3 = new Complex128( NaN, NaN );
	*
	* var out = ns.neg( z3 );
	* // returns <Complex128>[ NaN, NaN ]
	*/
	neg: typeof neg;

	/**
	* Scales a double-precision complex floating-point number by a real-valued double-precision floating-point scalar constant.
	*
	* @param alpha - scalar constant
	* @param z - complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z = new Complex128( 5.0, 3.0 );
	*
	* var out = ns.scale( 5.0, z );
	* // returns <Complex128>[ 25.0, 15.0 ]
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var out = new Float64Array( 2 );
	* var v = ns.scale.assign( 5.0, 5.0, 3.0, out, 1, 0 );
	* // returns <Float64Array>[ 25.0, 15.0 ]
	*
	* var bool = ( out === v );
	* // returns true
	*
	* @example
	* var Float64Array = require( '@stdlib/array-float64' );
	*
	* var z = new Float64Array( [ 5.0, 3.0 ] );
	*
	* var out = ns.scale.strided( 5.0, z, 1, 0, new Float64Array( 2 ), 1, 0 );
	* // returns <Float64Array>[ 25.0, 15.0 ]
	*/
	scale: typeof scale;

	/**
	* Subtracts two double-precision complex floating-point numbers.
	*
	* @param z1 - complex number
	* @param z2 - complex number
	* @returns result
	*
	* @example
	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
	*
	* var z1 = new Complex128( 5.0, 3.0 );
	* var z2 = new Complex128( -2.0, 1.0 );
	*
	* var out = ns.sub( z1, z2 );
	* // returns <Complex128>[ 7.0, 2.0 ]
	*/
	sub: typeof sub;
}

/**
* Base (i.e., lower-level) double-precision complex number functions.
*/
declare var ns: Namespace;


// EXPORTS //

export = ns;