Auto-generated commit

stdlib-js · Dec 16, 2023 · ff81d3d · ff81d3d
1 parent d7c330d
commit ff81d3d
Show file tree

Hide file tree

Showing 29 changed files with 445 additions and 64 deletions.
diff --git a/.github/.keepalive b/.github/.keepalive
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -41,15 +41,15 @@ jobs:
 
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:

diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -41,15 +41,15 @@ jobs:
 
       # Checkout repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:

diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml
@@ -45,16 +45,16 @@ jobs:
     steps:
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         timeout-minutes: 10
 
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Resolve package name:

diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml
@@ -61,8 +61,8 @@ jobs:
     steps:
       # Checkout main branch of repository:
       - name: 'Checkout main branch'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         with:
           ref: main
 
@@ -71,7 +71,7 @@ jobs:
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Create production branch:
@@ -134,8 +134,8 @@ jobs:
       # Checkout the repository:
       - name: 'Checkout repository'
         if: ${{ github.event.inputs.require-passing-tests == 'true' }}
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         with:
           # Use the `production` branch:
           ref: production
@@ -146,7 +146,7 @@ jobs:
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:
@@ -188,8 +188,8 @@ jobs:
     steps:
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Configure git:
       - name: 'Configure git'
@@ -259,7 +259,7 @@ jobs:
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:
@@ -364,8 +364,8 @@ jobs:
     steps:
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Configure git:
       - name: 'Configure git'
@@ -427,7 +427,7 @@ jobs:
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:
@@ -538,8 +538,8 @@ jobs:
     steps:
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Configure git:
       - name: 'Configure git'
@@ -609,7 +609,7 @@ jobs:
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:
@@ -719,8 +719,8 @@ jobs:
 
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         with:
           fetch-depth: 2
 

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -61,15 +61,15 @@ jobs:
 
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Configure git:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -58,15 +58,15 @@ jobs:
 
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:

diff --git a/.github/workflows/test_bundles.yml b/.github/workflows/test_bundles.yml
@@ -49,8 +49,8 @@ jobs:
     steps:
       # Checkout UMD branch of the repository:
       - name: 'Checkout branch with UMD build'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         with:
           ref: umd
 
@@ -59,7 +59,7 @@ jobs:
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 17
+          node-version: 20
 
       # Try loading the UMD bundle:
       - name: 'Try loading UMD bundle'
@@ -116,8 +116,8 @@ jobs:
 
       # Checkout ES modules branch of the repository:
       - name: 'Checkout branch with ESM build'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         with:
           ref: esm
 
@@ -126,7 +126,7 @@ jobs:
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 17
+          node-version: 20
 
       # Try loading the ES module bundle:
       - name: 'Try loading ESM'
@@ -161,8 +161,8 @@ jobs:
 
       # Checkout Deno branch of the repository:
       - name: 'Checkout branch with Deno build'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         with:
           ref: deno
 

diff --git a/.github/workflows/test_coverage.yml b/.github/workflows/test_coverage.yml
@@ -46,15 +46,15 @@ jobs:
 
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:

diff --git a/.github/workflows/test_install.yml b/.github/workflows/test_install.yml
@@ -58,15 +58,15 @@ jobs:
 
       # Checkout the repository:
       - name: 'Checkout repository'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+        # Pin action to full length commit SHA
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Install Node.js:
       - name: 'Install Node.js'
         # Pin action to full length commit SHA corresponding to v3.8.1
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
         with:
-          node-version: 16
+          node-version: 20
         timeout-minutes: 5
 
       # Install dependencies:

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -15,6 +15,7 @@ Dorrin Sotoudeh <[email protected]>
 Frank Kovacs <[email protected]>
 Harshita Kalani <[email protected]>
 James Gelok <[email protected]>
+Jaysukh Makvana <[email protected]>
 Jithin KS <[email protected]>
 Joey Reed <[email protected]>
 Jordan Gallivan <[email protected]>

diff --git a/README.md b/README.md
@@ -783,7 +783,7 @@ var bool = it.next().done;
 
 #### Complex64Array.prototype.get( i )
 
-Returns an array element located at position (index) `i`.
+Returns an array element located at a nonnegative integer position (index) `i`.
 
 ```javascript
 var realf = require( '@stdlib/complex-realf' );
@@ -814,6 +814,56 @@ var z = arr.get( 100 );
 // returns undefined
 ```
 
+<a name="method-at"></a>
+
+#### Complex64Array.prototype.at( i )
+
+Returns an array element located at integer position (index) `i`, with support for both nonnegative and negative integer positions.
+
+```javascript
+var realf = require( '@stdlib/complex-realf' );
+var imagf = require( '@stdlib/complex-imagf' );
+
+var arr = new Complex64Array( 10 );
+
+// Set the first, second, and last elements:
+arr.set( [ 1.0, -1.0 ], 0 );
+arr.set( [ 2.0, -2.0 ], 1 );
+arr.set( [ 9.0, -9.0 ], 9 );
+
+// Get the first element:
+var z = arr.at( 0 );
+// returns <Complex64>
+
+var re = realf( z );
+// returns 1.0
+
+var im = imagf( z );
+// returns -1.0
+
+// Get the last element:
+z = arr.at( -1 );
+// returns <Complex64>
+
+re = realf( z );
+// returns 9.0
+
+im = imagf( z );
+// returns -9.0
+```
+
+If provided an out-of-bounds index, the method returns `undefined`.
+
+```javascript
+var arr = new Complex64Array( 10 );
+
+var z = arr.at( 100 );
+// returns undefined
+
+z = arr.at( -100 );
+// returns undefined
+```
+
 <a name="method-set"></a>
 
 #### Complex64Array.prototype.set( z\[, i] )