Auto-generated commit

Author: stdlib-bot

README.md

@@ -77,14 +77,15 @@ Returns a list of ndarray casting modes.
 
 ```javascript
 var out = modes();
-// returns [ 'none', 'equiv', 'safe', 'same-kind', 'unsafe' ]
+// returns [ 'none', 'equiv', 'safe', 'mostly-safe', 'same-kind', 'unsafe' ]
 ```
 
 The output `array` contains the following modes:
 
 -   `none`: only allow casting between identical types.
 -   `equiv`: allow casting between identical and byte swapped types.
 -   `safe`: only allow "safe" casts.
+-   `mostly-safe`: allow "safe" casts and, for floating-point data types, downcasts.
 -   `same-kind`: allow "safe" casts and casts within the same kind (e.g., between signed integers or between floats).
 -   `unsafe`: allow casting between all types (including between integers and floats).
 
@@ -131,6 +132,9 @@ bool = isMode( 'equiv' );
 bool = isMode( 'safe' );
 // returns true
 
+bool = isMode( 'mostly-safe' );
+// returns true
+
 bool = isMode( 'same-kind' );
 // returns true
 

dist/index.js

@@ -4,13 +4,15 @@
 
     The output array contains the following modes:
 
-    - 'none': only allow casting between identical types
-    - 'equiv': allow casting between identical and byte swapped types
-    - 'safe': only allow "safe" casts
+    - 'none': only allow casting between identical types.
+    - 'equiv': allow casting between identical and byte swapped types.
+    - 'safe': only allow "safe" casts.
+    - 'mostly-safe': allow "safe" casts and, for floating-point data types,
+      downcasts.
     - 'same-kind': allow "safe" casts and casts within the same kind (e.g.,
-    between signed integers or between floats)
+      between signed integers or between floats).
     - 'unsafe': allow casting between all types (including between integers and
-    floats)
+      floats).
 
     Returns
     -------
@@ -20,7 +22,7 @@
     Examples
     --------
     > var out = {{alias}}()
-    [ 'none', 'equiv', 'safe', 'same-kind', 'unsafe' ]
+    [ 'none', 'equiv', 'safe', 'mostly-safe', 'same-kind', 'unsafe' ]
 
     See Also
     --------

dist/index.js.map

@@ -28,6 +28,7 @@
 *     -   'none': only allow casting between identical types
 *     -   'equiv': allow casting between identical and byte swapped types
 *     -   'safe': only allow "safe" casts
+*     -   'mostly-safe': allow "safe" casts and, for floating-point data types, downcasts
 *     -   'same-kind': allow "safe" casts and casts within the same kind (e.g.,
 *    between signed integers or between floats)
 *     -   'unsafe': allow casting between all types (including between integers and
@@ -37,7 +38,7 @@
 *
 * @example
 * var list = modes();
-* // returns [ 'none', 'equiv', 'safe', 'same-kind', 'unsafe' ]
+* // returns [ 'none', 'equiv', 'safe', 'mostly-safe', 'same-kind', 'unsafe' ]
 */
 declare function modes(): Array<string>;
 

docs/repl.txt

@@ -43,6 +43,10 @@ bool = isMode( 'safe' );
 console.log( bool );
 // => true
 
+bool = isMode( 'mostly-safe' );
+console.log( bool );
+// => true
+
 bool = isMode( 'same-kind' );
 console.log( bool );
 // => true

docs/types/index.d.ts

@@ -32,11 +32,14 @@ enum STDLIB_NDARRAY_CASTING_MODE {
 	// Only allow "safe" casts:
 	STDLIB_NDARRAY_SAFE_CASTING = 2,
 
+	// Allow "safe" casts and, for floating-point data types, downcasts:
+	STDLIB_NDARRAY_MOSTLY_SAFE_CASTING = 3,
+
 	// Allow "safe" casts and casts within the same kind (e.g., between signed integers or between floats):
-	STDLIB_NDARRAY_SAME_KIND_CASTING = 3,
+	STDLIB_NDARRAY_SAME_KIND_CASTING = 4,
 
 	// Allow casting between all types (including between integers and floats):
-	STDLIB_NDARRAY_UNSAFE_CASTING = 4
+	STDLIB_NDARRAY_UNSAFE_CASTING = 5
 };
 
 #endif // !STDLIB_NDARRAY_CASTING_MODES_H

examples/index.js

@@ -40,8 +40,9 @@ function enumerated() {
 		'none': 0,
 		'equiv': 1,
 		'safe': 2,
-		'same-kind': 3,
-		'unsafe': 4
+		'mostly-safe': 3,
+		'same-kind': 4,
+		'unsafe': 5
 	};
 }
 

include/stdlib/ndarray/casting_modes.h

@@ -27,7 +27,7 @@
 * var modes = require( '@stdlib/ndarray-casting-modes' );
 *
 * var list = modes();
-* // returns [ 'none', 'equiv', 'safe', 'same-kind', 'unsafe' ]
+* // returns [ 'none', 'equiv', 'safe', 'mostly-safe', 'same-kind', 'unsafe' ]
 */
 
 // MODULES //

lib/enum.js

@@ -32,7 +32,7 @@ var MODES = require( './modes.json' );
 *
 * @example
 * var list = modes();
-* // returns [ 'none', 'equiv', 'safe', 'same-kind', 'unsafe' ]
+* // returns [ 'none', 'equiv', 'safe', 'mostly-safe', 'same-kind', 'unsafe' ]
 */
 function modes() {
 	return MODES.slice();