From 0accb2a8d8cc0375d9675c57d9fb1451dbb5e349 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 12 Jan 2025 03:29:11 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 5 ++++- README.md | 6 ++++++ docs/types/index.d.ts | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 118591f..fe28f84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@
-## Unreleased (2025-01-11) +## Unreleased (2025-01-12)
@@ -20,6 +20,7 @@ ##### Features +- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706) - [`a94dcea`](https://github.com/stdlib-js/stdlib/commit/a94dceaa9469c774ee4622567e4c15a15e215bcf) - add `isColumnMajorString` to namespace - [`5e1be08`](https://github.com/stdlib-js/stdlib/commit/5e1be08ff661fb981dc4a91c2e9d37d7396327f5) - add `isRowMajorString` to namespace - [`8b1548f`](https://github.com/stdlib-js/stdlib/commit/8b1548fb45c1ff131f5edac20cb984344a2d28ec) - update namespace TypeScript declarations [(#3190)](https://github.com/stdlib-js/stdlib/pull/3190) @@ -149,6 +150,8 @@ A total of 2 people contributed to this release. Thank you to the following cont
+- [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - **feat:** update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706) _(by stdlib-bot)_ +- [`cff470f`](https://github.com/stdlib-js/stdlib/commit/cff470f9608165100c8c122fce70c40b1af864ec) - **docs:** update namespace table of contents (#4708) _(by stdlib-bot, Planeshifter)_ - [`a94dcea`](https://github.com/stdlib-js/stdlib/commit/a94dceaa9469c774ee4622567e4c15a15e215bcf) - **feat:** add `isColumnMajorString` to namespace _(by Athan Reines)_ - [`76872c7`](https://github.com/stdlib-js/stdlib/commit/76872c76f1c655afe5e87d9d894be37f6a07c08b) - **feat:** add `ndarray/base/assert/is-column-major-string` _(by Athan Reines)_ - [`5e1be08`](https://github.com/stdlib-js/stdlib/commit/5e1be08ff661fb981dc4a91c2e9d37d7396327f5) - **feat:** add `isRowMajorString` to namespace _(by Athan Reines)_ diff --git a/README.md b/README.md index 0339ca4..d9b92be 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,7 @@ var o = ns; - [`isBufferLengthCompatible( len, shape, strides, offset )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible]: determine if a buffer length is compatible with ndarray meta data. - [`isCastingMode( value )`][@stdlib/ndarray/base/assert/is-casting-mode]: test if an input value is a supported ndarray casting mode. - [`isColumnMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-column-major-contiguous]: determine if an array is column-major contiguous. +- [`isColumnMajorString( value )`][@stdlib/ndarray/base/assert/is-column-major-string]: test whether an input value is the string representing column-major order. - [`isColumnMajor( strides )`][@stdlib/ndarray/base/assert/is-column-major]: given a stride array, determine whether an array is column-major. - [`isComplexFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-complex-floating-point-data-type]: test if an input value is a supported ndarray complex-valued floating-point data type. - [`isContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-contiguous]: determine if an array is contiguous. @@ -97,6 +98,7 @@ var o = ns; - [`isRealDataType( value )`][@stdlib/ndarray/base/assert/is-real-data-type]: test if an input value is a supported ndarray real-valued data type. - [`isRealFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-real-floating-point-data-type]: test if an input value is a supported ndarray real-valued floating-point data type. - [`isRowMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-row-major-contiguous]: determine if an array is row-major contiguous. +- [`isRowMajorString( value )`][@stdlib/ndarray/base/assert/is-row-major-string]: test whether an input value is the string representing row-major order. - [`isRowMajor( strides )`][@stdlib/ndarray/base/assert/is-row-major]: given a stride array, determine whether an array is row-major. - [`isSafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-safe-data-type-cast]: determine whether an ndarray data type can be safely cast to another ndarray data type. - [`isSameKindDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-same-kind-data-type-cast]: determine whether an ndarray data type can be safely cast to, or is of the same "kind" as, another ndarray data type. @@ -227,6 +229,8 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [@stdlib/ndarray/base/assert/is-column-major-contiguous]: https://github.com/stdlib-js/ndarray-base-assert-is-column-major-contiguous +[@stdlib/ndarray/base/assert/is-column-major-string]: https://github.com/stdlib-js/ndarray-base-assert-is-column-major-string + [@stdlib/ndarray/base/assert/is-column-major]: https://github.com/stdlib-js/ndarray-base-assert-is-column-major [@stdlib/ndarray/base/assert/is-complex-floating-point-data-type]: https://github.com/stdlib-js/ndarray-base-assert-is-complex-floating-point-data-type @@ -255,6 +259,8 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [@stdlib/ndarray/base/assert/is-row-major-contiguous]: https://github.com/stdlib-js/ndarray-base-assert-is-row-major-contiguous +[@stdlib/ndarray/base/assert/is-row-major-string]: https://github.com/stdlib-js/ndarray-base-assert-is-row-major-string + [@stdlib/ndarray/base/assert/is-row-major]: https://github.com/stdlib-js/ndarray-base-assert-is-row-major [@stdlib/ndarray/base/assert/is-safe-data-type-cast]: https://github.com/stdlib-js/ndarray-base-assert-is-safe-data-type-cast diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 6f5aa82..d1fc933 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -28,6 +28,7 @@ import isBufferLengthCompatibleShape = require( '@stdlib/ndarray-base-assert-is- import isCastingMode = require( '@stdlib/ndarray-base-assert-is-casting-mode' ); import isColumnMajor = require( '@stdlib/ndarray-base-assert-is-column-major' ); import isColumnMajorContiguous = require( '@stdlib/ndarray-base-assert-is-column-major-contiguous' ); +import isColumnMajorString = require( '@stdlib/ndarray-base-assert-is-column-major-string' ); import isComplexFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-complex-floating-point-data-type' ); import isContiguous = require( '@stdlib/ndarray-base-assert-is-contiguous' ); import isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); @@ -42,6 +43,7 @@ import isRealDataType = require( '@stdlib/ndarray-base-assert-is-real-data-type' import isRealFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-real-floating-point-data-type' ); import isRowMajor = require( '@stdlib/ndarray-base-assert-is-row-major' ); import isRowMajorContiguous = require( '@stdlib/ndarray-base-assert-is-row-major-contiguous' ); +import isRowMajorString = require( '@stdlib/ndarray-base-assert-is-row-major-string' ); import isSafeDataTypeCast = require( '@stdlib/ndarray-base-assert-is-safe-data-type-cast' ); import isSameKindDataTypeCast = require( '@stdlib/ndarray-base-assert-is-same-kind-data-type-cast' ); import isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); @@ -262,6 +264,24 @@ interface Namespace { */ isColumnMajorContiguous: typeof isColumnMajorContiguous; + /** + * Tests whether an input value is the string representing column-major order. + * + * @param v - value to test + * @returns boolean result + * + * @example + * var bool = ns.isColumnMajorString( 'column-major' ); + * // returns true + * + * bool = ns.isColumnMajorString( 'row-major' ); + * // returns false + * + * bool = ns.isColumnMajorString( 'foo' ); + * // returns false + */ + isColumnMajorString: typeof isColumnMajorString; + /** * Tests whether an input value is a supported ndarray complex-valued floating-point data type. * @@ -747,6 +767,24 @@ interface Namespace { */ isRowMajorContiguous: typeof isRowMajorContiguous; + /** + * Tests whether an input value is the string representing row-major order. + * + * @param v - value to test + * @returns boolean result + * + * @example + * var bool = ns.isRowMajorString( 'row-major' ); + * // returns true + * + * bool = ns.isRowMajorString( 'column-major' ); + * // returns false + * + * bool = ns.isRowMajorString( 'foo' ); + * // returns false + */ + isRowMajorString: typeof isRowMajorString; + /** * Returns a boolean indicating if a provided ndarray data type can be safely cast to another ndarray data type. *