Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -121,7 +121,7 @@ indent_style = tab
 [*.{md,md.txt}]
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
 
 # Set properties for `usage.txt` files:
 [usage.txt]

.github/workflows/test_install.yml

@@ -50,8 +50,8 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
 
     # Define the sequence of job steps...
     steps:

.github/workflows/test_published_package.yml

@@ -47,8 +47,8 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
 
     # Define the job's steps:
     steps:

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-15)
+## Unreleased (2024-12-31)
 
 <section class="features">
 
 ### Features
 
+-   [`259b682`](https://github.com/stdlib-js/stdlib/commit/259b682b2fb67d03e2987ca02b57d0cbc631ae8e) - add support for specifying an array index cache and add support for linear indexing
 -   [`fb1ca76`](https://github.com/stdlib-js/stdlib/commit/fb1ca76ccf2f324c45b24411aa3fd1088a7a7b6e) - add `ndarray/to-fancy`
 
 </section>
@@ -22,6 +23,7 @@
 
 <details>
 
+-   [`259b682`](https://github.com/stdlib-js/stdlib/commit/259b682b2fb67d03e2987ca02b57d0cbc631ae8e) - **feat:** add support for specifying an array index cache and add support for linear indexing _(by Athan Reines)_
 -   [`0546f39`](https://github.com/stdlib-js/stdlib/commit/0546f395abecb502fd703aa364e758bd733cd18e) - **docs:** disable lint rule _(by Athan Reines)_
 -   [`5079aa3`](https://github.com/stdlib-js/stdlib/commit/5079aa30f3aa11908c78aac6750b4272852dbb4d) - **docs:** disable lint rule _(by Athan Reines)_
 -   [`fb1ca76`](https://github.com/stdlib-js/stdlib/commit/fb1ca76ccf2f324c45b24411aa3fd1088a7a7b6e) - **feat:** add `ndarray/to-fancy` _(by Athan Reines)_

CONTRIBUTORS

@@ -2,12 +2,14 @@
 #
 # Contributors listed in alphabetical order.
 
+Aadish Jain <jain.aadishj@gmail.com>
 Aayush Khanna <aayushiitbhu23@gmail.com>
 Abhijit Raut <abhijitmraut8010@gmail.com>
 Adarsh Palaskar <adarshpalaskar99@gmail.com>
 Aditya Sapra <adityaework@gmail.com>
 Ahmed Atwa <Ahmedatwa866@yahoo.com>
 Ahmed Kashkoush <ahmedkashkoush464@gmail.com>
+Ahmed Khaled <kahmd1444@gmail.com>
 Aleksandr <112382387+alextes90@users.noreply.github.com>
 Ali Salesi <ali_sal1381@yahoo.com>
 Aman Bhansali <bhansali.1@iitj.ac.in>
@@ -24,6 +26,8 @@ Dan Rose <danoftheroses@gmail.com>
 Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
+Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
+Divyansh Seth <59174836+sethdivyansh@users.noreply.github.com>
 Dominic Lim <46486515+domlimm@users.noreply.github.com>
 Dominik Moritz <domoritz@gmail.com>
 Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
@@ -46,11 +50,10 @@ Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
 Joris Labie <joris.labie1@gmail.com>
 Justin Dennison <justin1dennison@gmail.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
-Khaldon <kahmd1444@gmail.com>
 Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
-Lovelin <100030865+lovelindhoni@users.noreply.github.com>
+Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
 Manik Sharma <maniksharma.rke@gmail.com>
 Manvith M <148960168+manvith2003@users.noreply.github.com>
 Marcus Fantham <mfantham@users.noreply.github.com>
@@ -61,6 +64,7 @@ Mohammad Kaif <mdkaifprofession@gmail.com>
 Momtchil Momtchev <momtchil@momtchev.com>
 Muhammad Haris <harriskhan047@outlook.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
+Naveen Kumar <stupiddint@gmail.com>
 Neeraj Pathak <neerajrpathak710@gmail.com>
 Nishant Shinde <97207366+nishant-s7@users.noreply.github.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
@@ -71,10 +75,11 @@ Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <goswami.4@iitj.ac.in>
-Praneki <97080887+PraneGIT@users.noreply.github.com>
-Pratik <97464067+Pratik772846@users.noreply.github.com>
+Pranjal Jha <97080887+PraneGIT@users.noreply.github.com>
+Prashant Kumar Yadav <144602492+0PrashantYadav0@users.noreply.github.com>
+Pratik Singh <97464067+Pratik772846@users.noreply.github.com>
 Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
-Priyansh <88396544+itsspriyansh@users.noreply.github.com>
+Priyansh Prajapati <88396544+itsspriyansh@users.noreply.github.com>
 Priyanshu Agarwal <113460573+AgPriyanshu18@users.noreply.github.com>
 Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
 Raunak Kumar Gupta <raunakmodanwal321@gmail.com>
@@ -93,7 +98,7 @@ Sarthak Paandey <145528240+SarthakPaandey@users.noreply.github.com>
 Saurabh Singh <saurabhsraghuvanshi@gmail.com>
 Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
 Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
-Shivam <11shivam00@gmail.com>
+Shivam Ahir <11shivam00@gmail.com>
 Shraddheya Shendre <shendreshraddheya@gmail.com>
 Shubh Mehta <93862397+Shubh942@users.noreply.github.com>
 Shubham Mishra <shubh622005@gmail.com>
@@ -116,7 +121,6 @@ Vivek maurya <155618190+vivekmaurya001@users.noreply.github.com>
 Xiaochuan Ye <tap91624@gmail.com>
 Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
 Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
-naveen <stupiddint@gmail.com>
 olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
 rainn <88160429+AmCodesLame@users.noreply.github.com>
 rei2hu <reimu@reimu.ws>

README.md

@@ -125,6 +125,7 @@ The function supports the following options:
 
     -   **data**: the underlying index ndarray.
     -   **type**: the index type. Must be either `'mask'`, `'bool'`, or `'int'`.
+    -   **kind**: the index kind. Must be either `''`, `'cartesian'`, or `'linear'`.
     -   **dtype**: the [data type][@stdlib/ndarray/dtypes] of the underlying ndarray.
 
     If an ndarray index is not associated with a provided identifier, the `get` method should return `null`.
@@ -165,6 +166,7 @@ The function supports the following options:
 
     -   **data**: the underlying index ndarray.
     -   **type**: the index type. Must be either `'mask'`, `'bool'`, or `'int'`.
+    -   **kind**: the index kind. Must be either `''`, `'cartesian'`, or `'linear'`.
     -   **dtype**: the [data type][@stdlib/ndarray/dtypes] of the underlying ndarray.
 
     If an ndarray index is not associated with a provided identifier, the `get` method should return `null`.
@@ -228,6 +230,10 @@ For documentation and usage, see [`ndindex`][@stdlib/ndarray/index].
 
 // TODO: see array/to-fancy
 
+### Linear Indexing
+
+// TODO: only applies to non-zero-dimensional ndarrays. In non-strict mode, out-of-bounds indices return `undefined` and fail to assign.
+
 ### Broadcasting
 
 // TODO: see array/to-fancy