tstl - npm Package Compare versions

Comparing version 1.4.3 to 1.4.4

package.json

@@ -12,3 +12,3 @@ {
   "typings": "./lib/tstl.d.ts",
-  "version": "1.4.3",
+  "version": "1.4.4",
   "devDependencies": {
@@ -15,0 +15,0 @@ "@types/node": "^7.0.8"

README.md

@@ -1,90 +0,98 @@
-# <u>T</u>ypeScript-<u>STL</u>
-
+# TypeScript-STL
 [![NPM](https://nodei.co/npm/tstl.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/tstl)
+  - GitHub Repository: https://github.com/samchon/tstl
+  - Guide Documents: https://github.com/samchon/tstl/wiki
 
-GitHub Repository: https://github.com/samchon/tstl
 
+
 ## Introduction
-**STL** (Standard Template Library) Containers and Algorithms for **TypeScript**.
+STL (Standard Template Library) *Containers* and *Algorithms* for the **TypeScript**.
 
-**T**ypeScript-**STL** is an open-source JavaScript library providing containers and algorithms migrated from C++ STL. You can enjoy STL containers and algorithms in JavaScript. If TypeScript, you will be much happier feeling like using originla STL with type restriction and template programming.
+**T**ypeScript-**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.
 
-![Abstract Containers](http://samchon.github.io/tstl/images/design/class_diagram/abstract_containers.png)
+Below components are list of provided objects in the **T**ypeScript-**STL**. If you want to know more about the **TypeScript-STL**, then please read the [**Guide Documents**](https://github.com/samchon/tstl/wiki).
 
-##### Containers
-  - [**Linear containers**](http://samchon.github.io/tstl/api/interfaces/std.base.container.ilinearcontainer.html)
-    - [Vector](http://samchon.github.io/tstl/api/classes/std.vector.html)
-    - [List](http://samchon.github.io/tstl/api/classes/std.list.html)
-    - [Deque](http://samchon.github.io/tstl/api/classes/std.deque.html)
+### Containers
+  - **Linear Containers**
+    - [Vector `vector`](http://samchon.github.io/tstl/api/classes/std.vector.html)
+    - [List `list`](http://samchon.github.io/tstl/api/classes/std.list.html)
+    - [Deque `deque`](http://samchon.github.io/tstl/api/classes/std.deque.html)
   - **Associative Containers**
-    - [**Tree-structured Containers**](http://samchon.github.io/tstl/api/classes/std.base.tree.rbtree.html)
-      - [TreeSet](http://samchon.github.io/tstl/api/classes/std.treeset.html)
-      - [TreeMap](http://samchon.github.io/tstl/api/classes/std.treemap.html)
-      - [TreeMultiSet](http://samchon.github.io/tstl/api/classes/std.treemultiset.html)
-      - [TreeMultiMap](http://samchon.github.io/tstl/api/classes/std.treemultimap.html)
-    - [**Hashed Containers**](http://samchon.github.io/tstl/api/classes/std.base.hash.hashbuckets.html)
-      - [HashSet](http://samchon.github.io/tstl/api/classes/std.hashset.html)
-      - [HashMap](http://samchon.github.io/tstl/api/classes/std.hashmap.html)
-      - [HashMultiSet](http://samchon.github.io/tstl/api/classes/std.hashmultiset.html)
-      - [HashMultiMap](http://samchon.github.io/tstl/api/classes/std.hashmultimap.html)
+    - *Tree-structured Containers*
+      - [TreeSet `set`](http://samchon.github.io/tstl/api/classes/std.treeset.html)
+      - [TreeMultiSet `multiset`](http://samchon.github.io/tstl/api/classes/std.treemultiset.html)
+      - [TreeMap `map`](http://samchon.github.io/tstl/api/classes/std.treemap.html)
+      - [TreeMultiMap `multimap`](http://samchon.github.io/tstl/api/classes/std.treemultimap.html)
+    - *Hash-buckets based Container*
+      - [HashSet `unordered_set`](http://samchon.github.io/tstl/api/classes/std.hashset.html)
+      - [HashMultiSet `unordered_multiset`](http://samchon.github.io/tstl/api/classes/std.hashmultiset.html)
+      - [HashMap `unordered_map`](http://samchon.github.io/tstl/api/classes/std.hashmap.html)
+      - [HashMultiMap `unordered_multimap`](http://samchon.github.io/tstl/api/classes/std.hashmultimap.html)
   - **Adaptor Containers**
-    - [Queue](http://samchon.github.io/tstl/api/classes/std.queue.html)
-    - [Stack](http://samchon.github.io/tstl/api/classes/std.stack.html)
-    - [PriorityQueue](http://samchon.github.io/tstl/api/classes/std.priorityqueue.html)
+    - [Queue `queue`](http://samchon.github.io/tstl/api/classes/std.queue.html)
+    - [Stack `stack`](http://samchon.github.io/tstl/api/classes/std.stack.html)
+    - [PriorityQueue `priority_queue`](http://samchon.github.io/tstl/api/classes/std.priorityqueue.html)
 
-##### Global Functions
-  - [&lt;algorithm&gt;](http://www.cplusplus.com/reference/algorithm)
-  - [&lt;exception&gt;](http://www.cplusplus.com/reference/exception)
-  - [&lt;functional&gt;](http://www.cplusplus.com/reference/functional)
-    - [std.bind](http://samchon.github.io/tstl/api/modules/std.html#bind)
-  - [&lt;utility&gt;](http://www.cplusplus.com/reference/utility)
-    - [std.Pair](http://samchon.github.io/tstl/api/classes/std.pair.html)
+### Global Functions
+  - [`<algorithm>`](http://www.cplusplus.com/reference/algorithm/)
+    - [iterations](https://github.com/samchon/tstl/tree/master/src/std/algorithm/iterations.ts)
+    - [modifiers](https://github.com/samchon/tstl/tree/master/src/std/algorithm/modifiers.ts)
+    - [partition](https://github.com/samchon/tstl/tree/master/src/std/algorithm/partition.ts)
+    - [sorting](https://github.com/samchon/tstl/tree/master/src/std/algorithm/sorting.ts)
+    - [binary search](https://github.com/samchon/tstl/tree/master/src/std/algorithm/binary_search.ts)
+    - [union set](https://github.com/samchon/tstl/tree/master/src/std/algorithm/union_set.ts)
+    - [heap](https://github.com/samchon/tstl/tree/master/src/std/algorithm/heap.ts)
+    - [mathmatics](https://github.com/samchon/tstl/tree/master/src/std/algorithm/mathmatics.ts)
+  - [`<exception>`](http://www.cplusplus.com/reference/exception/)
+    - [Exception `exception`](http://samchon.github.io/tstl/api/classes/std.exception.html)
+      - [LogicError `logic_error`](http://samchon.github.io/tstl/api/classes/std.logicerror.html)
+      - [RuntimeError `runtime_error`](http://samchon.github.io/tstl/api/classes/std.runtimeerror.html)
+  - [`<functional>`](http://www.cplusplus.com/reference/functional/)
+    - [IComparable](http://samchon.github.io/tstl/api/interfaces/std.icomparable.html)
+  - [`<utility>`](http://www.cplusplus.com/reference/utility/)
+    - [Pair `pair`](http://samchon.github.io/tstl/api/classes/std.pair.html)
 
 
 
-## References
-You can learn and explore about TSTL more deeply with such below:
-
-  - [Guidebook (wiki)](https://github.com/samchon/tstl/wiki)
-  - [API Documents](http://samchon.github.io/tstl/api)
-  - [Class Diagram](http://samchon.github.io/tstl/design/class_diagram.pdf)
-
-
-
 ## Installation
-Installing *TSTL* in **node** is very easy. Just install with **npm** and **tsd**.
+### NPM Module
+Installing **TSTL** in *NodeJS* is very easy. Just install with the `npm`
 
-#### Node
-``` bash
-# Install TSTL from NPM modules
-npm install --save tstl 
+```bash
+# Install TSTL from the NPM module
+npm install --save tstl
 
-# If you need only header, then fetch from the @types
-npm install --save @types/tstl
+# If you need only definition, then fetch from the @types
+npm install --save-dev @types/tstl
 ```
 
-#### TypeScript
+### Usage (TypeScript)
 ``` typescript
 /// <reference types="tstl" />
-
 import std = require("tstl");
-let map: std.TreeMap<string, number> = new std.TreeMap<string, number>();
 
-map.insert(std.make_pair("First", 1));
-map.insert(["Second", 2]);
-map.insert_or_assign("Third", 3); // C++17 Feature.
-map.set("Fourth", 4); // Non-standard Feature.
+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 => string, value => number
+	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);
 ```
 
-#### Browser
-*TSTL* follows *CommonJS* module. 
+### In Browser
+**TypeScript-STL** follows the `CommonJS` module. 
 
-Use [browserify](https://www.npmjs.com/package/browserify) or just include *TSTL*'s *js file* with ```<script>``` tag.
+Use [browserify](https://www.npmjs.com/package/browserify) or just include the **TypeSript-STL**'s JS file with the `<script>` tag.
 
-###### In HTML Document
-``` javascript
-<script src="tstl.js"></script>
+```html
+<script src="http://samchon.github.io/dist/tstl.min.js"></script>
 ```
@@ -94,20 +102,85 @@
 
-## Index of Guidance, Wiki.
+## Differences between C++ STL
+### Binary operator
+```typescript
+namepsace std
+{
+    export interface IComparable<T>
+    {
+        equals(obj: T): boolean;
 
-  - [**Outline**](https://github.com/samchon/tstl/wiki/Home)
-    - [Introduction](https://github.com/samchon/tstl/wiki/Home#introduction)
-    - [References](https://github.com/samchon/tstl/wiki/Home#references)
-    - [Installation](https://github.com/samchon/tstl/wiki/Home#installation)
-  - [**Differences between C++**](https://github.com/samchon/tstl/wiki/Differences)
-    - [Naming Convention](https://github.com/samchon/tstl/wiki/Differences#naming-convention)
-    - [Operator Overriding](https://github.com/samchon/tstl/wiki/Differences#operator-overriding)
-    - [Iterator](https://github.com/samchon/tstl/wiki/Differences#iterator)
-    - [Tree Container](https://github.com/samchon/tstl/wiki/Differences#tree-container)
-    - [Hash Container](https://github.com/samchon/tstl/wiki/Differences#hash-container)
-  - [**Tutorial**](https://github.com/samchon/tstl/wiki/Tutorial)
-    - [Linear Container](https://github.com/samchon/tstl/wiki/Tutorial#linear-container)
-    - [Tree Container](https://github.com/samchon/tstl/wiki/Tutorial#tree-container)
-    - [Hash Container](https://github.com/samchon/tstl/wiki/Tutorial#hash-container)
-    - [Miscellaneous](https://github.com/samchon/tstl/wiki/Tutorial-Miscellaneous)
-      - [Algorithm](https://github.com/samchon/tstl/wiki/Tutorial-Miscellaneous#algorithm)
-      - [Functional](https://github.com/samchon/tstl/wiki/Tutorial-Miscellaneous#functional)
+        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
+```cpp
+// 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
+```typescript
+// 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](https://github.com/samchon/tstl)
+    - [NPM Repository](https://www.npmjs.com/package/tstl)
+  - **Documents**
+    - [**Guide Documents**](https://github.com/samchon/tstl/wiki)
+    - [API Documents](http://samchon.github.io/samchon/tstl)
+    - [Class Diagram](http://samchon.github.io/tstl/design/class_diagram.pdf)
+  - **Related Projects**
+    - [Samchon-Framework](https://github.com/samchon/framework)
+    - [3D-Bin-Packing](https://github.com/betterwaysystems/packer)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

904195

increased by0.46%

Lines of code

17657

increased by0.39%

Number of lines in readme file

185

increased by63.72%

No dependency changes