@stdlib/blas-base-cswap 0.0.4 → 0.0.7

package/docs/types/index.d.ts

@@ -18,6 +18,10 @@
 
 // TypeScript Version: 2.0
 
+/// <reference types="@stdlib/types"/>
+
+import { Complex64Array } from '@stdlib/types/array';
+
 /**
 * Interface describing `cswap`.
 */
@@ -34,8 +38,8 @@ interface Routine {
 	*
 	* @example
 	* var Complex64Array = require( `@stdlib/array/complex64` );
-	* var real = require( `@stdlib/complex/real` );
-	* var imag = require( `@stdlib/complex/imag` );
+	* var realf = require( `@stdlib/complex/realf` );
+	* var imagf = require( `@stdlib/complex/imagf` );
 	*
 	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 	* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -45,19 +49,19 @@ interface Routine {
 	* var z = y.get( 0 );
 	* // returns <Complex64>
 	*
-	* var re = real( z );
+	* var re = realf( z );
 	* // returns 1.0
 	*
-	* var im = imag( z );
+	* var im = imagf( z );
 	* // returns 2.0
 	*
 	* z = x.get( 0 );
 	* // returns <Complex64>
 	*
-	* re = real( z );
+	* re = realf( z );
 	* // returns 7.0
 	*
-	* im = imag( z );
+	* im = imagf( z );
 	* // returns 8.0
 	*/
 	( N: number, x: Complex64Array, strideX: number, y: Complex64Array, strideY: number ): Complex64Array; // tslint:disable-line:max-line-length
@@ -76,8 +80,8 @@ interface Routine {
 	*
 	* @example
 	* var Complex64Array = require( `@stdlib/array/complex64` );
-	* var real = require( `@stdlib/complex/real` );
-	* var imag = require( `@stdlib/complex/imag` );
+	* var realf = require( `@stdlib/complex/realf` );
+	* var imagf = require( `@stdlib/complex/imagf` );
 	*
 	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 	* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -87,19 +91,19 @@ interface Routine {
 	* var z = y.get( 0 );
 	* // returns <Complex64>
 	*
-	* var re = real( z );
+	* var re = realf( z );
 	* // returns 1.0
 	*
-	* var im = imag( z );
+	* var im = imagf( z );
 	* // returns 2.0
 	*
 	* z = x.get( 0 );
 	* // returns <Complex64>
 	*
-	* re = real( z );
+	* re = realf( z );
 	* // returns 7.0
 	*
-	* im = imag( z );
+	* im = imagf( z );
 	* // returns 8.0
 	*/
 	ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number, y: Complex64Array, strideY: number, offsetY: number ): Complex64Array; // tslint:disable-line:max-line-length
@@ -117,8 +121,8 @@ interface Routine {
 *
 * @example
 * var Complex64Array = require( `@stdlib/array/complex64` );
-* var real = require( `@stdlib/complex/real` );
-* var imag = require( `@stdlib/complex/imag` );
+* var realf = require( `@stdlib/complex/realf` );
+* var imagf = require( `@stdlib/complex/imagf` );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 * var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -128,25 +132,25 @@ interface Routine {
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 *
 * @example
 * var Complex64Array = require( `@stdlib/array/complex64` );
-* var real = require( `@stdlib/complex/real` );
-* var imag = require( `@stdlib/complex/imag` );
+* var realf = require( `@stdlib/complex/realf` );
+* var imagf = require( `@stdlib/complex/imagf` );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 * var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -156,19 +160,19 @@ interface Routine {
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 */
 declare var cswap: Routine;

package/docs/types/test.ts

@@ -16,6 +16,7 @@
 * limitations under the License.
 */
 
+import Complex64Array = require( '@stdlib/array-complex64' );
 import cswap = require( './index' );
 
 

package/lib/cswap.js

@@ -37,8 +37,8 @@ var Float32Array = require( '@stdlib/array-float32' );
 *
 * @example
 * var Complex64Array = require( '@stdlib/array-complex64' );
-* var real = require( '@stdlib/complex-real' );
-* var imag = require( '@stdlib/complex-imag' );
+* var realf = require( '@stdlib/complex-realf' );
+* var imagf = require( '@stdlib/complex-imagf' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 * var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -48,19 +48,19 @@ var Float32Array = require( '@stdlib/array-float32' );
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 */
 function cswap( N, x, strideX, y, strideY ) {

package/lib/cswap.native.js

@@ -38,8 +38,8 @@ var addon = require( './../src/addon.node' );
 *
 * @example
 * var Complex64Array = require( '@stdlib/array-complex64' );
-* var real = require( '@stdlib/complex-real' );
-* var imag = require( '@stdlib/complex-imag' );
+* var realf = require( '@stdlib/complex-realf' );
+* var imagf = require( '@stdlib/complex-imagf' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 * var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -49,19 +49,19 @@ var addon = require( './../src/addon.node' );
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 */
 function cswap( N, x, strideX, y, strideY ) {

package/lib/index.js

@@ -25,8 +25,8 @@
 *
 * @example
 * var Complex64Array = require( '@stdlib/array-complex64' );
-* var real = require( '@stdlib/complex-real' );
-* var imag = require( '@stdlib/complex-imag' );
+* var realf = require( '@stdlib/complex-realf' );
+* var imagf = require( '@stdlib/complex-imagf' );
 * var cswap = require( '@stdlib/blas-base-cswap' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -37,25 +37,25 @@
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 *
 * @example
 * var Complex64Array = require( '@stdlib/array-complex64' );
-* var real = require( '@stdlib/complex-real' );
-* var imag = require( '@stdlib/complex-imag' );
+* var realf = require( '@stdlib/complex-realf' );
+* var imagf = require( '@stdlib/complex-imagf' );
 * var cswap = require( '@stdlib/blas-base-cswap' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
@@ -66,19 +66,19 @@
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 */
 
@@ -86,13 +86,17 @@
 
 var join = require( 'path' ).join;
 var tryRequire = require( '@stdlib/utils-try-require' );
-var cswap = require( './main.js' );
+var isError = require( '@stdlib/assert-is-error' );
+var main = require( './main.js' );
 
 
 // MAIN //
 
+var cswap;
 var tmp = tryRequire( join( __dirname, './native.js' ) );
-if ( !(tmp instanceof Error) ) {
+if ( isError( tmp ) ) {
+	cswap = main;
+} else {
 	cswap = tmp;
 }
 

package/lib/ndarray.js

@@ -39,8 +39,8 @@ var Float32Array = require( '@stdlib/array-float32' );
 *
 * @example
 * var Complex64Array = require( '@stdlib/array-complex64' );
-* var real = require( '@stdlib/complex-real' );
-* var imag = require( '@stdlib/complex-imag' );
+* var realf = require( '@stdlib/complex-realf' );
+* var imagf = require( '@stdlib/complex-imagf' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 * var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -50,19 +50,19 @@ var Float32Array = require( '@stdlib/array-float32' );
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 */
 function cswap( N, x, strideX, offsetX, y, strideY, offsetY ) {

package/lib/ndarray.native.js

@@ -40,8 +40,8 @@ var addon = require( './../src/addon.node' );
 *
 * @example
 * var Complex64Array = require( '@stdlib/array-complex64' );
-* var real = require( '@stdlib/complex-real' );
-* var imag = require( '@stdlib/complex-imag' );
+* var realf = require( '@stdlib/complex-realf' );
+* var imagf = require( '@stdlib/complex-imagf' );
 *
 * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 * var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
@@ -51,19 +51,19 @@ var addon = require( './../src/addon.node' );
 * var z = y.get( 0 );
 * // returns <Complex64>
 *
-* var re = real( z );
+* var re = realf( z );
 * // returns 1.0
 *
-* var im = imag( z );
+* var im = imagf( z );
 * // returns 2.0
 *
 * z = x.get( 0 );
 * // returns <Complex64>
 *
-* re = real( z );
+* re = realf( z );
 * // returns 7.0
 *
-* im = imag( z );
+* im = imagf( z );
 * // returns 8.0
 */
 function cswap( N, x, strideX, offsetX, y, strideY, offsetY ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/blas-base-cswap",
-  "version": "0.0.4",
+  "version": "0.0.7",
   "description": "Interchanges two complex single-precision floating-point vectors.",
   "license": "Apache-2.0",
   "author": {
@@ -15,7 +15,7 @@
   ],
   "main": "./lib",
   "browser": "./lib/main.js",
-  "gypfile": true,
+  "gypfile": false,
   "directories": {
     "benchmark": "./benchmark",
     "doc": "./docs",
@@ -42,6 +42,8 @@
   },
   "dependencies": {
     "@stdlib/array-float32": "^0.0.x",
+    "@stdlib/assert-is-error": "^0.0.x",
+    "@stdlib/types": "^0.0.x",
     "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
     "@stdlib/utils-library-manifest": "^0.0.x",
     "@stdlib/utils-try-require": "^0.0.x"

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-> Package changelog.
-
-See [GitHub Releases](https://github.com/stdlib-js/blas-base-cswap/releases) for the changelog.

package/binding.gyp

@@ -1,265 +0,0 @@
-# @license Apache-2.0
-#
-# Copyright (c) 2020 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.
-
-# A `.gyp` file for building a Node.js native add-on.
-#
-# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
-# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
-{
-  # List of files to include in this file:
-  'includes': [
-    './include.gypi',
-  ],
-
-  # Define variables to be used throughout the configuration for all targets:
-  'variables': {
-    # Target name should match the add-on export name:
-    'addon_target_name%': 'addon',
-
-    # Fortran compiler (to override -Dfortran_compiler=<compiler>):
-    'fortran_compiler%': 'gfortran',
-
-    # Fortran compiler flags:
-    'fflags': [
-      # Specify the Fortran standard to which a program is expected to conform:
-      '-std=f95',
-
-      # Indicate that the layout is free-form source code:
-      '-ffree-form',
-
-      # Aggressive optimization:
-      '-O3',
-
-      # Enable commonly used warning options:
-      '-Wall',
-
-      # Warn if source code contains problematic language features:
-      '-Wextra',
-
-      # Warn if a procedure is called without an explicit interface:
-      '-Wimplicit-interface',
-
-      # Do not transform names of entities specified in Fortran source files by appending underscores (i.e., don't mangle names, thus allowing easier usage in C wrappers):
-      '-fno-underscoring',
-
-      # Warn if source code contains Fortran 95 extensions and C-language constructs:
-      '-pedantic',
-
-      # Compile but do not link (output is an object file):
-      '-c',
-    ],
-
-    # Set variables based on the host OS:
-    'conditions': [
-      [
-        'OS=="win"',
-        {
-          # Define the object file suffix:
-          'obj': 'obj',
-        },
-        {
-          # Define the object file suffix:
-          'obj': 'o',
-        }
-      ], # end condition (OS=="win")
-    ], # end conditions
-  }, # end variables
-
-  # Define compile targets:
-  'targets': [
-
-    # Target to generate an add-on:
-    {
-      # The target name should match the add-on export name:
-      'target_name': '<(addon_target_name)',
-
-      # Define dependencies:
-      'dependencies': [],
-
-      # Define directories which contain relevant include headers:
-      'include_dirs': [
-        # Local include directory:
-        '<@(include_dirs)',
-      ],
-
-      # List of source files:
-      'sources': [
-        '<@(src_files)',
-      ],
-
-      # Settings which should be applied when a target's object files are used as linker input:
-      'link_settings': {
-        # Define libraries:
-        'libraries': [
-          '<@(libraries)',
-        ],
-
-        # Define library directories:
-        'library_dirs': [
-          '<@(library_dirs)',
-        ],
-      },
-
-      # C/C++ compiler flags:
-      'cflags': [
-        # Enable commonly used warning options:
-        '-Wall',
-
-        # Aggressive optimization:
-        '-O3',
-      ],
-
-      # C specific compiler flags:
-      'cflags_c': [
-        # Specify the C standard to which a program is expected to conform:
-        '-std=c99',
-      ],
-
-      # C++ specific compiler flags:
-      'cflags_cpp': [
-        # Specify the C++ standard to which a program is expected to conform:
-        '-std=c++11',
-      ],
-
-      # Linker flags:
-      'ldflags': [],
-
-      # Apply conditions based on the host OS:
-      'conditions': [
-        [
-          'OS=="mac"',
-          {
-            # Linker flags:
-            'ldflags': [
-              '-undefined dynamic_lookup',
-              '-Wl,-no-pie',
-              '-Wl,-search_paths_first',
-            ],
-          },
-        ], # end condition (OS=="mac")
-        [
-          'OS!="win"',
-          {
-            # C/C++ flags:
-            'cflags': [
-              # Generate platform-independent code:
-              '-fPIC',
-            ],
-          },
-        ], # end condition (OS!="win")
-      ], # end conditions
-
-      # Define custom build actions for particular inputs:
-      'rules': [
-        {
-          # Define a rule for processing Fortran files:
-          'extension': 'f',
-
-          # Define the pathnames to be used as inputs when performing processing:
-          'inputs': [
-            # Full path of the current input:
-            '<(RULE_INPUT_PATH)'
-          ],
-
-          # Define the outputs produced during processing:
-          'outputs': [
-            # Store an output object file in a directory for placing intermediate results (only accessible within a single target):
-            '<(INTERMEDIATE_DIR)/<(RULE_INPUT_ROOT).<(obj)'
-          ],
-
-          # Define the rule for compiling Fortran based on the host OS:
-          'conditions': [
-            [
-              'OS=="win"',
-
-              # Rule to compile Fortran on Windows:
-              {
-                'rule_name': 'compile_fortran_windows',
-                'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Windows...',
-
-                'process_outputs_as_sources': 0,
-
-                # Define the command-line invocation:
-                'action': [
-                  '<(fortran_compiler)',
-                  '<@(fflags)',
-                  '<@(_inputs)',
-                  '-o',
-                  '<@(_outputs)',
-                ],
-              },
-
-              # Rule to compile Fortran on non-Windows:
-              {
-                'rule_name': 'compile_fortran_linux',
-                'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Linux...',
-
-                'process_outputs_as_sources': 1,
-
-                # Define the command-line invocation:
-                'action': [
-                  '<(fortran_compiler)',
-                  '<@(fflags)',
-                  '-fPIC', # generate platform-independent code
-                  '<@(_inputs)',
-                  '-o',
-                  '<@(_outputs)',
-                ],
-              }
-            ], # end condition (OS=="win")
-          ], # end conditions
-        }, # end rule (extension=="f")
-      ], # end rules
-    }, # end target <(addon_target_name)
-
-    # Target to copy a generated add-on to a standard location:
-    {
-      'target_name': 'copy_addon',
-
-      # Declare that the output of this target is not linked:
-      'type': 'none',
-
-      # Define dependencies:
-      'dependencies': [
-        # Require that the add-on be generated before building this target:
-        '<(addon_target_name)',
-      ],
-
-      # Define a list of actions:
-      'actions': [
-        {
-          'action_name': 'copy_addon',
-          'message': 'Copying addon...',
-
-          # Explicitly list the inputs in the command-line invocation below:
-          'inputs': [],
-
-          # Declare the expected outputs:
-          'outputs': [
-            '<(addon_output_dir)/<(addon_target_name).node',
-          ],
-
-          # Define the command-line invocation:
-          'action': [
-            'cp',
-            '<(PRODUCT_DIR)/<(addon_target_name).node',
-            '<(addon_output_dir)/<(addon_target_name).node',
-          ],
-        },
-      ], # end actions
-    }, # end target copy_addon
-  ], # end targets
-}