Skip to content

Latest commit

 

History

History
146 lines (106 loc) · 3.41 KB

tpl.readme.md

File metadata and controls

146 lines (106 loc) · 3.41 KB
Raw

About

{{pkg.description}}

This package provides different function memoization implementations for functions with arbitrary arguments and custom result caching using ES6 Map API like implementations. Unlike native ES6 Maps, the implementations MUST support value, not just referential, equality semantics (e.g. those provided by @thi.ng/associative) or @thi.ng/cache). The latter also support automatically pruning of memoization caches, based on different strategies. See doc strings for further details.

Available memoization functions

{{meta.status}}

{{repo.supportPackages}}

{{repo.relatedPackages}}

{{meta.blogPosts}}

Installation

{{pkg.install}}

{{pkg.size}}

Dependencies

{{pkg.deps}}

{{repo.examples}}

API

{{pkg.docs}}

import * as m from "@thi.ng/memoize";

// (optional, for custom caching)
import { EquivMap } from "@thi.ng/associative";
import { LRUCache } from "@thi.ng/cache";

Optimized version for single arg functions

import { memoize1 } from "@thi.ng/memoize";

foo = memoize1((x: number) => {
    console.log("exec");
    return x * 10;
});

foo(1);
// exec
// 10
foo(1);
// 10

import { EquivMap } from "@thi.ng/associative";

// with custom cache
foo = memoize1(
    (x: number[]) => (console.log("exec"), x[0] * 10),
    // custom ES6 Map impl which compares by value, not by reference
    new EquivMap()
);

foo([1]);
// exec
// 10

// would be a cache miss w/ native ES6 Map
// due to lack of value equality semantics
foo([1]);
// 10

import { LRUCache } from "@thi.ng/cache";

// use LRU cache to limit cache size
foo = memoize1(
    (x: number[]) => (console.log("exec"), x[0] * 10),
    new LRUCache(null, { maxlen: 3 })
);

Arbitrary args

import { memoize } from "@thi.ng/memoize";
import { EquivMap } from "@thi.ng/associative";

const dotProduct = memoize(
    (x: number[], y: number[]) => {
        console.log("exec");
        return x[0] * y[0] + x[1] * y[1];
    },
    new EquivMap()
);

dotProduct([1,2], [3,4]);
// exec
// 11
dotProduct([1,2], [3,4]);
// 11

Via JSON.stringify()

import { memoizeJ } from "@thi.ng/memoize";

const dotProduct = memoizeJ(
    (x: number[], y: number[]) => {
        console.log("exec");
        return x[0] * y[0] + x[1] * y[1];
    }
);

dotProduct([1, 2], [3, 4]);
// exec
// 11

dotProduct([1, 2], [3, 4]);
// 11