tstl

TypeScript-STL

• GitHub Repository: https://github.com/samchon/tstl
• Guide Documents: https://github.com/samchon/tstl/wiki

Introduction

STL (Standard Template Library) Containers and Algorithms for the TypeScript.

TypeScript-STL is an open-source project providing containers and algorithms migrated from C++ STL to TypeScript. You can enjoy the STL's own specific coantainers and algorithms in the JavaScript. If TypeScript, you also can take advantage of type restrictions and generic programming with the TypeScript.

Below components are list of provided objects in the TypeScript-STL. If you want to know more about the TypeScript-STL, then please read the Guide Documents.

Containers

• Linear Containers
  • Vector vector
  • List list
  • Deque deque
• Associative Containers
  • Tree-structured Containers
    • TreeSet set
    • TreeMultiSet multiset
    • TreeMap map
    • TreeMultiMap multimap
  • Hash-buckets based Container
    • HashSet unordered_set
    • HashMultiSet unordered_multiset
    • HashMap unordered_map
    • HashMultiMap unordered_multimap
• Adaptor Containers
  • Queue queue
  • Stack stack
  • PriorityQueue priority_queue

Global Functions

• <algorithm>
  • iterations
  • modifiers
  • partition
  • sorting
  • binary search
  • union set
  • heap
  • mathmatics
• <exception>
  • Exception exception
    • LogicError logic_error
    • RuntimeError runtime_error
• <functional>
  • IComparable
• <utility>
  • Pair pair

Installation

NPM Module

Installing TSTL in NodeJS is very easy. Just install with the npm

# Install TSTL from the NPM module
npm install --save tstl

# If you need only definition, then fetch from the @types
npm install --save-dev @types/tstl

Usage (TypeScript)

/// <reference types="tstl" />
import std = require("tstl");

let map: std.TreeMap<number, string> = new std.TreeMap<number, string>();

// INSERT ITEMS
map.insert(std.make_pair(1, "First"));
map.insert([4, "Fourth"]); // via Tuple, C++11 Feature
map.insert_or_assign(5, "Fifth"); // C++17 Feature
map.set(9, "Nineth"); // Instead of the operetor[](Key)

// ITERATION
for (let it = map.begin(); !it.equals(map.end()); it = it.next())
	console.log(it.first, it.second); // (key => number, value => string)

// LOWER_BOUND
let x = map.lower_bound(3);
console.log("lower bound of 3 is: " + x.first + ", " + x.second);

In Browser

TypeScript-STL follows the CommonJS module.

Use browserify or just include the TypeSript-STL's JS file with the <script> tag.

<script src="http://samchon.github.io/dist/tstl.min.js"></script>

Differences between C++ STL

Binary operator

namepsace std
{
    export interface IComparable<T>
    {
        equals(obj: T): boolean;

        less?(obj: T): boolean;
        hashCode?(): number;
    }
}

Iterator & Iteration

Operators

C++ STL	TypeScript-STL
Iterator.operator==()	Iterator.equals()
Iterator.operator*()	Iterator.value

                    | `MapIterator.first`
                    | `MapIterator.second`

Advancing

C++ STL	TypeScript-STL
it--	it = it.prev();
it++	it = it.next();
advance(it, 5);	it = it.advance(5);

Sample Codes

C++ STL

// Vector
std::vector<int> v(5, 1);
for (auto it = v.begin(); it != it.end(); v++)
    std::cout << *it << std::endl;

// TreeMap
std::map<int, std::string> m;
m.insert(std.make_pair(1, "first"));
m.insert({2, "second"});
m.emplace(3, "third");

m[4] = "fourth";
std::cout << m[4] << std::endl;

for (auto it = m.begin(); it != m.end(); it++)
    std::cout << it->first << ", " << it->second << std::endl;

TypeScript-STL

// Vector
let v = new std.Vector<number>(5, 1);
for (let it = v.begin(); !it.equals(v.end()); it = it.next())
    console.log(it.value);

// TreeMap
let m = new std.TreeMap<number, string>();
m.insert(std.make_pair(1, "first"));
m.insert([2, "second"]);
m.emplace(3, "third");

m.set(4, "fourth");
console.log(m.get(4));

for (let it = m.begin(); !it.equals(m.end()); it = it.next())
    console.log(it.first, it.second);

References

• Repositories
  • GitHub Repository
  • NPM Repository
• Documents
  • Guide Documents
  • API Documents
  • Class Diagram
• Related Projects
  • Samchon-Framework
  • 3D-Bin-Packing