Skip to content

Commit ebda942

Browse files
committed
Initial commit
1 parent 3c0f592 commit ebda942

File tree

1 file changed

+2
-16
lines changed

1 file changed

+2
-16
lines changed

README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
[![codecov](https://codecov.io/github/raphasampaio/multidimensionalsparsearrays.jl/graph/badge.svg?token=I2kXECoZxZ)](https://codecov.io/github/raphasampaio/multidimensionalsparsearrays.jl)
55
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
66

7-
A Julia package for multidimensional sparse arrays.
8-
97
## Overview
108

119
`MultidimensionalSparseArrays.jl` provides a `SparseArray` type that efficiently stores and manipulates multidimensional arrays with a high proportion of zero elements. Unlike dense arrays, `SparseArray` only stores non-zero values, significantly reducing memory consumption for sparse data.
@@ -14,7 +12,7 @@ This package is designed to be a flexible and intuitive tool for scientific comp
1412

1513
## Comparison with `SparseArrays.jl`
1614

17-
`MultidimensionalSparseArrays.jl` is designed to provide a flexible and easy-to-use interface for N-dimensional sparse arrays. While Julia's standard library `SparseArrays.jl` is highly optimized for 1-D and 2-D sparse arrays (vectors and matrices), `MultidimensionalSparseArrays.jl` offers a more general-purpose solution for higher-dimensional sparse data.
15+
`MultidimensionalSparseArrays.jl` is designed to provide a flexible and easy-to-use interface for N-dimensional sparse arrays. While Julia's standard library [`SparseArrays.jl`](https://github.com/JuliaSparse/SparseArrays.jl) is highly optimized for 1-D and 2-D sparse arrays (vectors and matrices), `MultidimensionalSparseArrays.jl` offers a more general-purpose solution for higher-dimensional sparse data.
1816

1917
Key differences include:
2018

@@ -33,8 +31,6 @@ Key differences include:
3331

3432
## Installation
3533

36-
The package can be installed with the Julia package manager. From the Julia REPL, type `]` to enter the Pkg REPL mode and run:
37-
3834
```julia
3935
pkg> add MultidimensionalSparseArrays
4036
```
@@ -145,16 +141,6 @@ The following are the key exports of the package:
145141
- `hasindex`: Check for a stored value at an index.
146142
- `to_dense`: Convert to a dense array.
147143

148-
For more details, please refer to the docstrings of the individual functions.
149-
150-
## Code Formatting
151-
152-
This project uses `JuliaFormatter.jl` to ensure a consistent code style. To format your code locally, run the following command from the root of the project:
153-
154-
```bash
155-
julia --project=format format/format.jl
156-
```
157-
158144
## Contributing
159145

160-
Contributions are welcome! Please feel free to submit a pull request or open an issue.
146+
Contributions, bug reports, and feature requests are welcome! Feel free to open an issue or submit a pull request.

0 commit comments

Comments
 (0)