Skip to content

Commit e87dc88

Browse files
ain1084ain1084
committed
Initial commit.
0 parents  commit e87dc88

File tree

13 files changed

+5081
-0
lines changed

13 files changed

+5081
-0
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
3+
{
4+
"name": "Node.js & JavaScript",
5+
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6+
"image": "mcr.microsoft.com/devcontainers/javascript-node",
7+
8+
// Features to add to the dev container. More info: https://containers.dev/features.
9+
// "features": {},
10+
11+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
12+
// "forwardPorts": [],
13+
14+
// Use 'postCreateCommand' to run commands after the container is created.
15+
// "postCreateCommand": "yarn install",
16+
17+
// Configure tool-specific properties.
18+
"customizations": {
19+
"vscode": {
20+
"extensions": ["fill-labs.dependi", "DavidAnson.vscode-markdownlint"]
21+
}
22+
}
23+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
24+
// "remoteUser": "root"
25+
}

‎.github/workflows/ci.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
workflow_dispatch:
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v2
18+
- name: Set up Node.js
19+
uses: actions/setup-node@v2
20+
with:
21+
node-version: '18'
22+
23+
- run: npm install
24+
25+
# Run tests
26+
- name: Run Tests
27+
run: npm test
28+
29+
# Generate Documentation
30+
- name: Generate Documentation
31+
run: npm run docs
32+
33+
# Deploy Documentation to GitHub Pages
34+
- name: Deploy to GitHub Pages
35+
if: success()
36+
uses: peaceiris/actions-gh-pages@v3
37+
with:
38+
github_token: ${{ secrets.GH_TOKEN }}
39+
publish_dir: ./docs

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
dist
3+
docs
4+
.DS_Store

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

‎LICENSE‎

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
MIT License
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.
20+
21+
22+
Apache License
23+
Version 2.0, January 2004
24+
http://www.apache.org/licenses/
25+
26+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
27+
28+
1. Definitions.
29+
30+
"License" shall mean the terms and conditions for use, reproduction,
31+
and distribution as defined by Sections 1 through 9 of this document.
32+
33+
"Licensor" shall mean the copyright owner or entity authorized by
34+
the copyright owner that is granting the License.
35+
36+
"Legal Entity" shall mean the union of the acting entity and all
37+
other entities that control, are controlled by, or are under common
38+
control with that entity. For the purposes of this definition,
39+
"control" means (i) the power, direct or indirect, to cause the
40+
direction or management of such entity, whether by contract or
41+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
42+
outstanding shares, or (iii) beneficial ownership of such entity.
43+
44+
"You" (or "Your") shall mean an individual or Legal Entity
45+
exercising permissions granted by this License.
46+
47+
"Source" form shall mean the preferred form for making modifications,
48+
including but not limited to software source code, documentation
49+
source, and configuration files.
50+
51+
"Object" form shall mean any form resulting from mechanical
52+
transformation or translation of a Source form, including but
53+
not limited to compiled object code, generated documentation,
54+
and conversions to other media types.
55+
56+
"Work" shall mean the work of authorship, whether in Source or
57+
Object form, made available under the License, as indicated by a
58+
copyright notice that is included in or attached to the work
59+
(an example is provided in the Appendix below).
60+
61+
"Derivative Works" shall mean any work, whether in Source or Object
62+
form, that is based on (or derived from) the Work and for which the
63+
editorial revisions, annotations, elaborations, or other modifications
64+
represent, as a whole, an original work of authorship. For the purposes
65+
of this License, Derivative Works shall not include works that remain
66+
separable from, or merely link (or bind by name) to the interfaces of,
67+
the Work and Derivative Works thereof.
68+
69+
"Contribution" shall mean any work of authorship, including
70+
the original version of the Work and any modifications or additions
71+
to that Work or Derivative Works thereof, that is intentionally
72+
submitted to Licensor for inclusion in the Work by the copyright owner
73+
or by an individual or Legal Entity authorized to submit on behalf of
74+
the copyright owner. For the purposes of this definition, "submitted"
75+
means any form of electronic, verbal, or written communication sent
76+
to the Licensor or its representatives, including but not limited to
77+
communication on electronic mailing lists, source code control systems,
78+
and issue tracking systems that are managed by, or on behalf of, the
79+
Licensor for the purpose of discussing and improving the Work, but
80+
excluding communication that is conspicuously marked or otherwise
81+
designated in writing by the copyright owner as "Not a Contribution."
82+
83+
"Contributor" shall mean Licensor and any individual or Legal Entity
84+
on behalf of whom a Contribution has been received by Licensor and
85+
subsequently incorporated within the Work.
86+
87+
2. Grant of Copyright License. Subject to the terms and conditions of
88+
this License, each Contributor hereby grants to You a perpetual,
89+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
90+
copyright license to reproduce, prepare Derivative Works of,
91+
publicly display, publicly perform, sublicense, and distribute the
92+
Work and such Derivative Works in Source or Object form.
93+
94+
3. Grant of Patent License. Subject to the terms and conditions of
95+
this License, each Contributor hereby grants to You a perpetual,
96+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
97+
(except as stated in this section) patent license to make, have made,
98+
use, offer to sell, sell, import, and otherwise transfer the Work,
99+
where such license applies only to those patent claims licensable
100+
by such Contributor that are necessarily infringed by their
101+
Contribution(s) alone or by combination of their Contribution(s)
102+
with the Work to which such Contribution(s) was submitted. If You
103+
institute patent litigation against any entity (including a
104+
cross-claim or counterclaim in a lawsuit) alleging that the Work
105+
or a Contribution incorporated within the Work constitutes direct
106+
or contributory patent infringement, then any patent licenses
107+
granted to You under this License for that Work shall terminate
108+
as of the date such litigation is filed.
109+
110+
4. Redistribution. You may reproduce and distribute copies of the
111+
Work or Derivative Works thereof in any medium, with or without
112+
modifications, and in Source or Object form, provided that You
113+
meet the following conditions:
114+
115+
(a) You must give any other recipients of the Work or
116+
Derivative Works a copy of this License; and
117+
118+
(b) You must cause any modified files to carry prominent notices
119+
stating that You changed the files; and
120+
121+
(c) You must retain, in the Source form of any Derivative Works
122+
that You distribute, all copyright, patent, trademark, and
123+
attribution notices from the Source form of the Work,
124+
excluding those notices that do not pertain to any part of
125+
the Derivative Works; and
126+
127+
(d) If the Work includes a "NOTICE" text file as part of its
128+
distribution, then any Derivative Works that You distribute must
129+
include a readable copy of the attribution notices contained
130+
within such NOTICE file, excluding those notices that do not
131+
pertain to any part of the Derivative Works, in at least one
132+
of the following places: within a NOTICE text file distributed
133+
as part of the Derivative Works; within the Source form or
134+
documentation, if provided along with the Derivative Works; or,
135+
within a display generated by the Derivative Works, if and
136+
wherever such third-party notices normally appear. The contents
137+
of the NOTICE file are for informational purposes only and
138+
do not modify the License. You may add Your own attribution
139+
notices within Derivative Works that You distribute, alongside
140+
or as an addendum to the NOTICE text from the Work, provided
141+
that such additional attribution notices cannot be construed
142+
as modifying the License.
143+
144+
You may add Your own copyright statement to Your modifications and
145+
may provide additional or different license terms and conditions
146+
for use, reproduction, or distribution of Your modifications, or
147+
for any such Derivative Works as a whole, provided Your use,
148+
reproduction, and distribution of the Work otherwise complies with
149+
the conditions stated in this License.
150+
151+
5. Submission of Contributions. Unless You explicitly state otherwise,
152+
any Contribution intentionally submitted for inclusion in the Work
153+
by You to the Licensor shall be under the terms and conditions of
154+
this License, without any additional terms or conditions.
155+
Notwithstanding the above, nothing herein shall supersede or modify
156+
the terms of any separate license agreement you may have executed
157+
with Licensor regarding such Contributions.
158+
159+
6. Trademarks. This License does not grant permission to use the trade
160+
names, trademarks, service marks, or product names of the Licensor,
161+
except as required for describing the origin of the Work and
162+
reproducing the content of the NOTICE file.
163+
164+
7. Disclaimer of Warranty. Unless required by applicable law or
165+
agreed to in writing, Licensor provides the Work (and each
166+
Contributor provides its Contributions) on an "AS IS" BASIS,
167+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
168+
implied, including, without limitation, any warranties or conditions
169+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
170+
PARTICULAR PURPOSE. You are solely responsible for determining the
171+
appropriateness of using or redistributing the Work and assume any
172+
risks associated with Your exercise of permissions under this License.
173+
174+
8. Limitation of Liability. In no event and under no legal theory,
175+
whether in tort (including negligence), contract, or otherwise,
176+
unless required by applicable law (such as deliberate and grossly
177+
negligent acts) or agreed to in writing, shall any Contributor be
178+
liable to You for damages, including any direct, indirect, special,
179+
incidental, or consequential damages of any character arising as a
180+
result of this License or out of the use or inability to use the
181+
Work (including but not limited to damages for loss of goodwill,
182+
work stoppage, computer failure or malfunction, or any and all
183+
other commercial damages or losses), even if such Contributor
184+
has been advised of the possibility of such damages.
185+
186+
9. Accepting Warranty or Additional Liability. While redistributing
187+
the Work or Derivative Works thereof, You may choose to offer,
188+
and charge a fee for, acceptance of support, warranty, indemnity,
189+
or other liability obligations and/or rights consistent with this
190+
License. However, in accepting such obligations, You may act only
191+
on Your own behalf and on Your sole responsibility, not on behalf
192+
of any other Contributor, and only if You agree to indemnify,
193+
defend, and hold each Contributor harmless for any liability
194+
incurred by, or claims asserted against, such Contributor by reason
195+
of your accepting any such warranty or additional liability.
196+
197+
END OF TERMS AND CONDITIONS
198+
199+
APPENDIX: How to apply the Apache License to your work.
200+
201+
To apply the Apache License to your work, attach the following
202+
boilerplate notice, with the fields enclosed by brackets "{}"
203+
replaced with your own identifying information. (Don't include
204+
the brackets!) The text should be enclosed in the appropriate
205+
comment syntax for the file format. We also recommend that a
206+
file or class name and description of purpose be included on the
207+
same "printed page" as the copyright notice for easier
208+
identification within third-party archives.
209+
210+
Copyright {yyyy} {name of copyright owner}
211+
212+
Licensed under the Apache License, Version 2.0 (the "License");
213+
you may not use this file except in compliance with the License.
214+
You may obtain a copy of the License at
215+
216+
http://www.apache.org/licenses/LICENSE-2.0
217+
218+
Unless required by applicable law or agreed to in writing, software
219+
distributed under the License is distributed on an "AS IS" BASIS,
220+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
221+
See the License for the specific language governing permissions and
222+
limitations under the License.

‎README.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# @ain1084/array-buffer-partitioner
2+
3+
[![npm version](https://badge.fury.io/js/@ain1084%2Farray-buffer-partitioner.svg)](https://badge.fury.io/js/@ain1084%2Farray-buffer-partitioner)
4+
[![Documentation](https://github.com/ain1084/array-buffer-partitioner/workflows/docs/badge.svg)](https://github.com/ain1084/array-buffer-partitioner/actions?query=workflow%3Adocs)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
7+
8+
Partition an ArrayBuffer into multiple TypedArray views efficiently, while handling complex memory layouts and ensuring optimal alignment for better access performance.
9+
10+
## Overview
11+
12+
`@ain1084/array-buffer-partitioner` is a utility library designed to create multiple `TypedArray` views on a single `ArrayBuffer` or `SharedArrayBuffer`. This can be particularly useful when dealing with various data types that need to coexist within a single buffer, without manually calculating offsets and ensuring correct alignment.
13+
14+
### Features
15+
16+
- Create multiple `TypedArray` views from a single `ArrayBuffer` or `SharedArrayBuffer`.
17+
- Efficient memory partitioning without manual offset calculations.
18+
- Future-proof: planned support for alignment adjustment to optimize memory access performance.
19+
20+
## Installation
21+
22+
Install the library via npm:
23+
24+
```sh
25+
npm install @ain1084/array-buffer-partitioner
26+
```
27+
28+
## Usage
29+
30+
Import the `createArrayBufferViews` function to partition an `ArrayBuffer` or `SharedArrayBuffer` into multiple views:
31+
32+
```typescript
33+
import { createArrayBufferViews } from '@ain1084/array-buffer-partitioner';
34+
35+
const views = createArrayBufferViews(ArrayBuffer, {
36+
data: [Float32Array, 1024],
37+
index: [Uint32Array, 1],
38+
flag: [Uint8Array, 1]
39+
});
40+
41+
console.log(views.data.length); // 1024
42+
console.log(views.data.byteOffset); // 0
43+
console.log(views.index.length); // 1
44+
console.log(views.flag.length); // 1
45+
console.log(views.flag.byteOffset); // 4100
46+
console.log(views.data.buffer.byteLength); // 4104
47+
```
48+
49+
## API
50+
51+
### `createArrayBufferViews`
52+
53+
Creates multiple `TypedArray` views on a single `ArrayBuffer` or `SharedArrayBuffer`.
54+
55+
#### Parameters
56+
57+
- `BufferType` (`{ new(size: number): ArrayBuffer | SharedArrayBuffer }`): The constructor for the buffer, either `ArrayBuffer` or `SharedArrayBuffer`.
58+
- `config` (`Record<string, [TypedArrayConstructor, number]>`): An object specifying the desired views. Each key represents the name of the view, and the value is a tuple where:
59+
- The first element is the `TypedArray` class name (e.g., `Float32Array`, `Uint32Array`).
60+
- The second element is the number of elements for that view.
61+
62+
#### Returns
63+
64+
An object containing the views, with each key corresponding to the provided configuration.
65+
66+
## Future Plans
67+
68+
- **Alignment Support**: Future versions will include alignment support to ensure efficient access patterns, especially when working with mixed data types like `Float32Array` and `Uint8Array`. This will improve the performance of memory access and help avoid inefficient alignments.
69+
70+
## Contributing
71+
72+
Contributions are welcome! If you have ideas, suggestions, or issues, please create an issue on the [GitHub repository](https://github.com/ain1084/array-buffer-partitioner).
73+
74+
## License
75+
76+
This project is licensed under the MIT OR Apache-2.0 license.

‎jest.config.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"preset": "ts-jest",
3+
"testEnvironment": "node",
4+
"roots": ["<rootDir>/src", "<rootDir>/tests"],
5+
"moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
6+
}

0 commit comments

Comments
 (0)