Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yappy2000d/pps-ndarray
Multi-dimensional array implementation
https://github.com/yappy2000d/pps-ndarray
cpp numpy
Last synced: 8 days ago
JSON representation
Multi-dimensional array implementation
- Host: GitHub
- URL: https://github.com/yappy2000d/pps-ndarray
- Owner: yappy2000d
- License: mit
- Created: 2024-09-16T13:19:26.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-25T13:28:29.000Z (about 1 month ago)
- Last Synced: 2024-10-31T13:04:24.656Z (8 days ago)
- Topics: cpp, numpy
- Language: C++
- Homepage: https://yappy2000d.github.io/PPs-Ndarray/
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ndarray-11
[](https://isocpp.org/std/the-standard)
A simple yet powerful multi-dimensional array implementation in C++11, inspired by Python's NumPy. This library provides an intuitive interface for working with multi-dimensional arrays, supporting slicing, indexing, and initialization through initializer lists.
## Features
- Multi-dimensional arrays: Supports arrays with arbitrary dimensions, enabling complex data structures.
- Initializer list support: Easily initialize arrays with nested lists.
- Indexing and slicing: Access and manipulate data through familiar Python-like syntax.
- C++11 support: Fully compatible with C++11 and upper, using modern type traits and std::initializer_list.
## Installation
To use Ndarray-11, simply download or clone the repository and include the header file in your project.
Then, include the header file in your code:
```cpp
#include "ndarray-11.hpp"
```
## Usage
- For more examples, see the [examples](./examples/) directory.
- Documentation is generated using Doxygen, and can be found [here](https://yappy2000d.github.io/PPs-Ndarray/).
### Basic Initialization
Create a 3D array with pre-defined dimensions:
```cpp
pp::Ndarray array = {
{
{0, 0, 0},
{0, 0, 0}
},
{
{1, 1, 1},
{1, 1, 1}
}
};
```
### Accessing Elements
Access elements with an intuitive function call syntax, similar to Python's NumPy:
```cpp
array(0, 1, 2) = 777; // Equivalent to array[0][1][2] = 777;
```
### Slicing
Perform slicing operations with a Python-like syntax using the `Range` class:
```cpp
auto sliced_array = array["0:1, ::1"];
```
### Printing Arrays
Print the array using the `<<` operator:
```cpp
std::cout << array << std::endl;
```
### Example
```cpp
#include "ndarray-11.hpp"
int main() {
pp::Ndarray array = {
{
{0, 0, 0},
{0, 0, 0}
},
{
{1, 1, 1},
{1, 1, 1}
}
};
// Set value at [0][1][2]
array(0, 1, 2) = 777;
// Print the array
std::cout << array << std::endl;
return 0;
}
```
## Limitations
- Negative indices when slicing are not supported yet. https://github.com/yappy2000d/PPs-Ndarray/issues/1
- Broadcasting is not supported yet.
- Dimensions must remain the same after slicing. https://github.com/yappy2000d/PPs-Ndarray/issues/2
- Dimensions must be specified at compile time.
## Cooming not so soon
Check out the [Milestones](https://github.com/yappy2000d/PPs-Ndarray/milestones)
## Contributions
Contributions are welcome! If you find bugs or have suggestions for improvements, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
## Acknowledgements
- [@rexwolflan](https://github.com/LeiwolfLanze) for technical guidance and code review.