array-base-symmetric

Symmetric array utilities.

https://github.com/m0oxc/array-base-symmetric

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords

2d allocate array band banded callback fill javascript map multidimensional namespace nodejs stdlib symmetric
Last synced: 6 months ago · JSON representation ·

Repository

Symmetric array utilities.

Basic Info
  • Host: GitHub
  • Owner: M0OXC
  • License: apache-2.0
  • Language: JavaScript
  • Default Branch: main
  • Size: 43.9 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
2d allocate array band banded callback fill javascript map multidimensional namespace nodejs stdlib symmetric
Created 10 months ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

🎉 Array Base Symmetric: Symmetric Array Utilities 🎉

Version License Node.js npm

Welcome to the Array Base Symmetric repository! This project provides utilities for working with symmetric arrays in JavaScript. If you’re looking to simplify your array manipulation tasks, you’re in the right place.

📦 Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Usage
  5. API Reference
  6. Contributing
  7. License
  8. Contact
  9. Releases

📖 Introduction

Symmetric arrays are a unique data structure where the elements mirror each other. This can be useful in various applications, such as mathematical computations, graphics, and data storage. The Array Base Symmetric library provides a set of tools to create, manipulate, and analyze these arrays effectively.

✨ Features

  • Create Symmetric Arrays: Easily generate symmetric arrays with predefined sizes.
  • Manipulate Elements: Add, remove, or modify elements while maintaining symmetry.
  • Matrix Operations: Perform standard matrix operations like addition, subtraction, and multiplication on symmetric arrays.
  • Nested Structures: Support for nested symmetric arrays for complex data representation.
  • Utility Functions: Various utility functions to check symmetry, transpose matrices, and more.

🚀 Installation

To get started with Array Base Symmetric, you need to install it via npm. Run the following command in your terminal:

bash npm install array-base-symmetric

🔧 Usage

Here’s a simple example of how to use the Array Base Symmetric library:

```javascript const { createSymmetricArray, addElement } = require('array-base-symmetric');

// Create a 3x3 symmetric array const symmetricArray = createSymmetricArray(3);

// Add an element addElement(symmetricArray, 5, 1, 1); console.log(symmetricArray); ```

This code snippet creates a symmetric array and adds an element to it. The library takes care of maintaining symmetry automatically.

📚 API Reference

createSymmetricArray(size)

Creates a symmetric array of the given size.

  • Parameters:
    • size (Number): The size of the symmetric array.
  • Returns: A symmetric array.

addElement(array, value, row, col)

Adds an element to the specified position in the symmetric array.

  • Parameters:
    • array (Array): The symmetric array.
    • value (Any): The value to add.
    • row (Number): The row index.
    • col (Number): The column index.

checkSymmetry(array)

Checks if the given array is symmetric.

  • Parameters:
    • array (Array): The array to check.
  • Returns: Boolean indicating whether the array is symmetric.

For more detailed documentation, please refer to the API documentation.

🤝 Contributing

We welcome contributions! If you want to help improve the Array Base Symmetric library, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Submit a pull request.

Please ensure that your code adheres to the existing style and includes appropriate tests.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

📬 Contact

For questions or feedback, feel free to reach out:

  • Email: example@example.com
  • GitHub: M0OXC

🚀 Releases

You can find the latest releases of the Array Base Symmetric library here. Download the latest version and start using it today!


Thank you for checking out the Array Base Symmetric library! We hope it helps you with your array manipulation tasks. If you have any questions, don't hesitate to reach out. Happy coding!

Owner

  • Login: M0OXC
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Release event: 1
  • Watch event: 1
  • Push event: 752
  • Create event: 3
Last Year
  • Release event: 1
  • Watch event: 1
  • Push event: 752
  • Create event: 3

Dependencies

package.json npm
  • @stdlib/assert-is-array-array ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/math-base-special-floor ^0.2.3 development
  • @stdlib/math-base-special-pow ^0.3.0 development
  • @stdlib/math-base-special-sqrt ^0.2.2 development
  • @stdlib/utils-constant-function ^0.2.2 development
  • @stdlib/utils-keys ^0.2.2 development
  • istanbul ^0.4.1 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/array-base-symmetric-filled2d-by github:stdlib-js/array-base-symmetric-filled2d-by#main
  • @stdlib/utils-define-read-only-property ^0.2.2