Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Nov 25, 2023
1 parent 9da39d7 commit bd5c7dc
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 17 deletions.
5 changes: 0 additions & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,6 @@ indent_size = 2
indent_style = space
indent_size = 2

# Set properties for `tslint.json` files:
[tslint.json]
indent_style = space
indent_size = 2

# Set properties for `tsconfig.json` files:
[tsconfig.json]
indent_style = space
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ jobs:
# For all dependencies, check in all *.js files if they are still used; if not, remove them:
jq -r '.dependencies | keys[]' ./package.json | while read -r dep; do
dep=$(echo "$dep" | xargs)
if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
if ! find lib -name "*.js" -exec grep -q "$dep" {} + && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
jq --indent 2 "del(.dependencies[\"$dep\"])" ./package.json > ./package.json.tmp
mv ./package.json.tmp ./package.json
fi
Expand All @@ -129,7 +129,7 @@ jobs:
continue
fi
dep=$(echo "$dep" | xargs)
if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
if ! find lib -name "*.js" -exec grep -q "$dep" {} + && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
jq --indent 2 "del(.devDependencies[\"$dep\"])" ./package.json > ./package.json.tmp
mv ./package.json.tmp ./package.json
fi
Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Brendan Graetz <[email protected]>
Bruno Fenzl <[email protected]>
Christopher Dambamuromo <[email protected]>
Dan Rose <[email protected]>
Daniel Killenberger <[email protected]>
Dominik Moritz <[email protected]>
Dorrin Sotoudeh <[email protected]>
Frank Kovacs <[email protected]>
Expand All @@ -29,6 +30,7 @@ Ognjen Jevremović <[email protected]>
Philipp Burckhardt <[email protected]>
Pranav Goswami <[email protected]>
Ricky Reusser <[email protected]>
Robert Gislason <[email protected]>
Roman Stetsyk <[email protected]>
Ryan Seal <[email protected]>
Seyyed Parsa Neshaei <[email protected]>
Expand All @@ -37,4 +39,3 @@ Stephannie Jiménez Gacha <[email protected]>
Yernar Yergaziyev <[email protected]>
orimiles5 <[email protected]>
rei2hu <[email protected]>
Robert Gislason <[email protected]>
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ The constructor accepts the following `options`:
The constructor supports the following `modes`:

- **throw**: specifies that a `FancyArray` instance should throw an error when an index exceeds array dimensions.
- **normalize**: specifies that a `FancyArray` instance should normalize negative indices and throw an error when an index exceeds array dimensions.
- **wrap**: specifies that a `FancyArray` instance should wrap around an index exceeding array dimensions using modulo arithmetic.
- **clamp**: specifies that a `FancyArray` instance should set an index exceeding array dimensions to either `0` (minimum index) or the maximum index.

Expand Down
20 changes: 12 additions & 8 deletions docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,21 +51,25 @@
options.mode: string (optional)
Specifies how to handle indices which exceed array dimensions. If equal
to 'throw', an ndarray instance throws an error when an index exceeds
array dimensions. If equal to 'normalize', an ndarray instance
normalizes negative indices and throws an error when an index exceeds
array dimensions. If equal to 'wrap', an ndarray instance wraps around
indices exceeding array dimensions using modulo arithmetic. If equal to
'clamp', an ndarray instance sets an index exceeding array dimensions to
either `0` (minimum index) or the maximum index. Default: 'throw'.
'clamp', an ndarray instance sets an index exceeding array dimensions
to either `0` (minimum index) or the maximum index. Default: 'throw'.

options.submode: Array<string> (optional)
Specifies how to handle subscripts which exceed array dimensions. If a
mode for a corresponding dimension is equal to 'throw', an ndarray
instance throws an error when a subscript exceeds array dimensions. If
equal to 'wrap', an ndarray instance wraps around subscripts exceeding
array dimensions using modulo arithmetic. If equal to 'clamp', an
ndarray instance sets a subscript exceeding array dimensions to either
`0` (minimum index) or the maximum index. If the number of modes is
fewer than the number of dimensions, the function recycles modes using
modulo arithmetic. Default: [ options.mode ].
equal to 'normalize', an ndarray instance normalizes negative
subscripts and throws an error when a subscript exceeds array
dimensions. If equal to 'wrap', an ndarray instance wraps around
subscripts exceeding array dimensions using modulo arithmetic. If equal
to 'clamp', an ndarray instance sets a subscript exceeding array
dimensions to either `0` (minimum index) or the maximum index. If the
number of modes is fewer than the number of dimensions, the function
recycles modes using modulo arithmetic. Default: [ options.mode ].

options.readonly: boolean (optional)
Boolean indicating whether an array should be read-only. Default: false.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
"@stdlib/assert-is-nonnegative-integer": "^0.1.0",
"@stdlib/assert-is-plain-object": "^0.1.1",
"@stdlib/assert-is-positive-integer": "^0.1.0",
"@stdlib/bench": "^0.2.0",
"@stdlib/bench": "^0.2.1",
"@stdlib/complex-float32": "^0.1.1",
"@stdlib/complex-float64": "^0.1.1",
"@stdlib/complex-imagf": "^0.1.1",
Expand Down

0 comments on commit bd5c7dc

Please sign in to comment.