Giter Club home page Giter Club logo

vec.js's Introduction

Vec.js Node.js CI

Vec.js is a JavaScript library for nodeJS and browser. Vec.js extends JavaScript Array. The library is heavily inspired and influenced by F# Array module.

Documentation

Please go to Vec APIs to read more.

Installation

npm install @nyinyithann/vec.js

Getting started

Vec extends Array. All built-in methods of Array can be used with it. The following snippet demonstrates using Array's built-in method reduce with Vec.

const fnVec = Vec.of(
  (x) => x * x * x,
  (x) => x / 216,
  Math.sqrt
);
const howLongAStormLast = (d) => fnVec.reduce((s, f) => f(s), d);
console.log(howLongAStormLast(10.5)); // => 2.315032397181517

Vec has the following methods.

Static Methods

empty
init
create
isVec
some2
every2
fold2
foldRight2
forEach2
map2
map3
zip3
unfold
allPairs

Instance Methods

isEmpty
copy
countBy
findRight
findIndexRight
head
tail
get
set
last
take
takeWhile
skipWhile
min
max
minBy
maxBy
sum
sumBy
average
averageBy
splitAt
partition
scan
scanRight
windowed
zip
unzip
distinct
distinctBy
pairwise
except
groupBy
mapFold
mapFoldRight
chunkBySize
binarySearch
permute
transpose

Some sample code below.

// unfold
const fibonacci = (n) =>
  Vec.unfold(
    ([x, [a, b]]) => (x < n ? [a + b, [x + 1, [b, a + b]]] : null),
    [0, [0, 1]]
  );
const fibOf10 = fibonacci(10);
console.log(fibOf10);
// => [ 1, 2, 3, 5, 8, 13, 21, 34, 55, 89 ]

// mapFold
const oneToTen = Vec.init(10, (x) => x + 1);
const mapFoldResult = oneToTen.mapFold((acc, elem) => [acc, acc + elem], 0);
console.log(mapFoldResult);
// => [ [ 0, 1, 3, 6, 10, 15, 21, 28, 36, 45 ], 55 ]

// scan
const scannedResult = oneToTen.scan((acc, elem) => acc + elem, 0);
console.log(scannedResult);
// => [ 0, 1, 3, 6, 10, 15, 21, 28, 36, 45, 55 ]

// groups
const groups = oneToTen.groupBy((x) => (x % 2 === 0 ? "Even" : "Odd"), true);
console.log(groups);
// => [ [ 'Odd', [ 1, 3, 5, 7, 9 ] ], [ 'Even', [ 2, 4, 6, 8, 10 ] ] ]

Vec can be instantiated as follows:

const vec = new Vec();
vec.push(1, 2, 3, 4, 5);
// => [ 1, 2, 3, 4, 5 ]

const vec1 = new Vec(1, 2, 3, 4, 5);
// => [ 1, 2, 3, 4, 5 ]

const vec2 = Vec.of(1, 2, 3, 4, 5);
// => [ 1, 2, 3, 4, 5 ]

const vec3 = Vec.from([1, 2, 3, 4, 5]);
// => [ 1, 2, 3, 4, 5 ]

const vec4 = Vec.init(5, (x) => x + 1);
// => [ 1, 2, 3, 4, 5 ]

const vec5 = Vec.unfold((x) => (x <= 5 ? [x, x + 1] : undefined), 1);
// => [ 1, 2, 3, 4, 5 ]

const vec6 = Vec.create(5, 1);
// => [ 1, 1, 1, 1, 1 ]

const emptyVec = Vec.empty();
emptyVec.push(1, 2, 3, 4, 5);
// => [ 1, 2, 3, 4, 5 ]

Please go to Vec APIs to read more.

Author

Nyi Nyi Than - @nyinyithann

Credit

License

MIT

vec.js's People

Contributors

nyinyithann avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.