From 0ddd0558d44a1f2584e18e6e1975adab2278e04f Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Tue, 18 Mar 2025 08:05:23 +0000 Subject: [PATCH] remove: remove `cadd` from namespace This commit removes the `cadd` symbol from the `@stdlib/math/base/ops` namespace due to a package migration. BREAKING CHANGE: remove `cadd` To migrate, users should access the same symbol via the `@stdlib/complex/float64/base` namespace. --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../math/base/ops/docs/types/index.d.ts | 46 ------------------- .../@stdlib/math/base/ops/lib/index.js | 9 ---- 2 files changed, 55 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts index 7f5d89455822..eac8afe4f46c 100644 --- a/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts @@ -20,58 +20,12 @@ /* eslint-disable max-lines */ -import cadd = require( '@stdlib/complex/float64/base/add' ); import cmul = require( '@stdlib/complex/float64/base/mul' ); /** * Interface describing the `ops` 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 real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); - * - * var z = new Complex128( 5.0, 3.0 ); - * // returns - * - * var out = ns.cadd( z, z ); - * // returns - * - * var re = real( out ); - * // returns 10.0 - * - * var im = imag( out ); - * // returns 6.0 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var out = new Float64Array( 2 ); - * var v = ns.cadd.assign( 5.0, 3.0, 5.0, 3.0, out, 1, 0 ); - * // returns [ 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.cadd.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 ); - * // returns [ 10.0, 6.0 ] - */ - cadd: typeof cadd; - /** * Multiplies two double-precision complex floating-point numbers. * diff --git a/lib/node_modules/@stdlib/math/base/ops/lib/index.js b/lib/node_modules/@stdlib/math/base/ops/lib/index.js index 853a0730114b..b959f3b40e14 100644 --- a/lib/node_modules/@stdlib/math/base/ops/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/ops/lib/index.js @@ -36,15 +36,6 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); */ var ns = {}; -/** -* @name cadd -* @memberof ns -* @readonly -* @type {Function} -* @see {@link module:@stdlib/complex/float64/base/add} -*/ -setReadOnly( ns, 'cadd', require( '@stdlib/complex/float64/base/add' ) ); - /** * @name cmul * @memberof ns