npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

multidim-array-index

v0.6.0

Published

maps multidimensional array indices to monodimensional array index

Downloads

14

Readme

multidim-array-index

maps multidimensional array indices to monodimensional array index

NPM version Build Status Dependency Status JavaScript Style Guide

Table Of Contents:

Installation

With npm do

npm install multidim-array-index

Examples

All code in the examples below is intended to be contained into a single file.

var multiDimArrayIndex = require('multidim-array-index')

1th-order

In the monodimensional case, it just returns the index itself.

var i3 = multiDimArrayIndex.bind(null, [3])

i3([0]) // 0
i3([1]) // 1
i3([2]) // 2

2th-order

For a two dimensional case, for instance a matrix, it is equivalent to the function (i, j, numCols) => j + i * numCols

var i2x3 = multiDimArrayIndex.bind(null, [2, 3])

i2x3([0, 0]) // 0
i2x3([0, 1]) // 1
i2x3([0, 2]) // 2
i2x3([1, 0]) // 3
i2x3([1, 1]) // 4
i2x3([1, 2]) // 5

3th-order

var i2x3x4 = multiDimArrayIndex.bind(null, [2, 2, 2])

i2x3x4([0, 0, 0]) // 0
i2x3x4([0, 0, 1]) // 1
i2x3x4([0, 0, 2]) // 2
i2x3x4([0, 0, 3]) // 3
i2x3x4([0, 1, 0]) // 4
i2x3x4([0, 1, 1]) // 5
i2x3x4([0, 1, 2]) // 6
i2x3x4([0, 1, 3]) // 7
i2x3x4([1, 0, 0]) // 8
i2x3x4([1, 0, 1]) // 9
i2x3x4([1, 0, 2]) // 10
i2x3x4([1, 0, 3]) // 11
i2x3x4([1, 1, 0]) // 12
i2x3x4([1, 1, 1]) // 13
i2x3x4([1, 1, 2]) // 14
i2x3x4([1, 1, 3]) // 15

i2x2x2([0, 0, 0]) //// 0
i2x2x2([0, 0, 1]) // 1
i2x2x2([0, 1, 0]) // 2
i2x2x2([0, 1, 1]) // 3
i2x2x2([1, 0, 0]) // 4
i2x2x2([1, 0, 1]) // 5
i2x2x2([1, 1, 0]) // 6
i2x2x2([1, 1, 1]) // 7

API

multiDimArrayIndex(dimension, indices)

  • @param {Array} dimensions defines the shape of the multi dimensional array
  • @param {Array} indices to transform
  • @returns {Number} index of an equivalent mono dimensional array

Given dimensions d_1, d_2, d_3 .. d_n and indices i_1, i_2, i_3 .. i_n index is computed by formula

index = i_n + i_(n-1) * d_n + i_(n-2) * d_n * d_(n-1) + ... + i_2 * d_n * d_(n-1) * ... * d_3 + i_1 * d_n * ... * d_2

multiDimArrayIndex.error

An object exposing the following error messages:

  • outOfBoundIndex

For example, the following snippets will throw

// outOfBoundIndex

i3([11])
i2x3x4([2, 3, 5])

License

MIT