cleanup and optimizations, set interface compliance

Author: SalvatorePreviti

.vscode/settings.json

@@ -104,6 +104,8 @@
     "type_traits": "cpp",
     "memory": "cpp",
     "__functional_base_03": "cpp",
-    "__tuple": "cpp"
+    "__tuple": "cpp",
+    "__functional_03": "cpp",
+    "ostream": "cpp"
   }
 }

benchmarks/iterator.bench.js

@@ -14,7 +14,7 @@ bench.suite('iterator', (suite) => {
 
   suite.scope(() => {
     const x = new Set(data)
-    suite.benchmark('Set', () => {
+    suite.benchmark('Set.iterator', () => {
       let n = 0
       for (const j of x) {
         n += j
@@ -23,16 +23,38 @@ bench.suite('iterator', (suite) => {
     })
   })
 
+  suite.scope(() => {
+    const x = new Set(data)
+    suite.benchmark('Set.forEach', () => {
+      let n = 0
+      x.forEach((v) => {
+        n += v
+      })
+      return n
+    })
+  })
+
   suite.scope(() => {
     const x = new RoaringBitmap32(data)
-    suite.benchmark('RoaringBitmap32', () => {
+    suite.benchmark('RoaringBitmap32.iterator', () => {
       let n = 0
       for (const j of x) {
         n += j
       }
       return n
     })
   })
+
+  suite.scope(() => {
+    const x = new RoaringBitmap32(data)
+    suite.benchmark('RoaringBitmap32.forEach', () => {
+      let n = 0
+      x.forEach((v) => {
+        n += v
+      })
+      return n
+    })
+  })
 })
 
 if (require.main === module) {

documentation/api/index.d.md

@@ -103,7 +103,7 @@ The iterator may throw exception if the bitmap is changed during the iteration.
 ### CRoaringVersion
 
 Property: The version of the CRoaring libary as a string.
-Example: "0.2.42"
+Example: "0.4.0"
 
 ```typescript
 var CRoaringVersion: string
@@ -118,7 +118,7 @@ string
 ### PackageVersion
 
 Property: The version of the roaring npm package as a string.
-Example: "0.2.2"
+Example: "1.2.0"
 
 ```typescript
 var PackageVersion: string

documentation/api/index.d/roaringbitmap32.md

@@ -71,8 +71,12 @@
     - [contentToString(maxLength)][methoddeclaration-66]
     - [statistics()][methoddeclaration-67]
   - Properties
-    - [size][propertydeclaration-0]
-    - [isEmpty][propertydeclaration-1]
+    - [CRoaringVersion][propertydeclaration-0]
+    - [CRoaringVersion][propertydeclaration-2]
+    - [PackageVersion][propertydeclaration-1]
+    - [PackageVersion][propertydeclaration-3]
+    - [size][propertydeclaration-4]
+    - [isEmpty][propertydeclaration-5]
 
 # RoaringBitmap32
 
@@ -1627,6 +1631,66 @@ public statistics(): RoaringBitmap32Statistics;
 
 ## Properties
 
+### CRoaringVersion
+
+Property: The version of the CRoaring libary as a string.
+Example: "0.4.0"
+
+```typescript
+public static readonly CRoaringVersion: string;
+```
+
+**Type**
+
+string
+
+---
+
+### CRoaringVersion
+
+Property: The version of the CRoaring libary as a string.
+Example: "0.4.0"
+
+```typescript
+public readonly CRoaringVersion: string;
+```
+
+**Type**
+
+string
+
+---
+
+### PackageVersion
+
+Property: The version of the roaring npm package as a string.
+Example: "1.2.0"
+
+```typescript
+public static readonly PackageVersion: string;
+```
+
+**Type**
+
+string
+
+---
+
+### PackageVersion
+
+Property: The version of the roaring npm package as a string.
+Example: "1.2.0"
+
+```typescript
+public readonly PackageVersion: string;
+```
+
+**Type**
+
+string
+
+---
+
 ### size
 
 Property. Gets the number of items in the set (cardinality).
@@ -1778,5 +1842,9 @@ boolean
 [methoddeclaration-66]: roaringbitmap32.md#contenttostringmaxlength
 [methoddeclaration-67]: roaringbitmap32.md#statistics
 [interfacedeclaration-1]: ../index.d.md#roaringbitmap32statistics
-[propertydeclaration-0]: roaringbitmap32.md#size
-[propertydeclaration-1]: roaringbitmap32.md#isempty
+[propertydeclaration-0]: roaringbitmap32.md#croaringversion
+[propertydeclaration-2]: roaringbitmap32.md#croaringversion
+[propertydeclaration-1]: roaringbitmap32.md#packageversion
+[propertydeclaration-3]: roaringbitmap32.md#packageversion
+[propertydeclaration-4]: roaringbitmap32.md#size
+[propertydeclaration-5]: roaringbitmap32.md#isempty

index.d.ts

@@ -27,10 +27,52 @@ import roaring = require('./')
  * @implements {Iterable<number>}
  * @author Salvatore Previti
  */
-export class RoaringBitmap32 implements Iterable<number> {
+export class RoaringBitmap32 implements Set<number> {
   // Allows: import RoaringBitmap32 from 'roaring/RoaringBitmap32'
   private static readonly default: typeof RoaringBitmap32
 
+  /**
+   * Property: The version of the CRoaring libary as a string.
+   * Example: "0.4.0"
+   *
+   * @export
+   * @constant
+   * @type {string} The version of the CRoaring libary as a string. Example: "0.2.42"
+   */
+  public static readonly CRoaringVersion: string
+
+  /**
+   * Property: The version of the roaring npm package as a string.
+   * Example: "1.2.0"
+   *
+   * @export
+   * @constant
+   * @type {string} The version of the roaring npm package as a string. Example: "0.2.42"
+   */
+  public static readonly PackageVersion: string
+
+  /**
+   * Property: The version of the CRoaring libary as a string.
+   * Example: "0.4.0"
+   *
+   * @export
+   * @constant
+   * @type {string} The version of the CRoaring libary as a string. Example: "0.2.42"
+   * @memberof RoaringBitmap32
+   */
+  public readonly CRoaringVersion: string
+
+  /**
+   * Property: The version of the roaring npm package as a string.
+   * Example: "1.2.0"
+   *
+   * @export
+   * @constant
+   * @type {string} The version of the roaring npm package as a string. Example: "0.2.42"
+   * @memberof RoaringBitmap32
+   */
+  public readonly PackageVersion: string
+
   /**
    * Property. Gets the number of items in the set (cardinality).
    *
@@ -336,7 +378,7 @@ export class RoaringBitmap32 implements Iterable<number> {
   public static xorMany(...values: RoaringBitmap32[]): RoaringBitmap32
 
   /**
-   * [Symbol.iterator]() Gets a new iterator able to iterate all values in the set in order.
+   * [Symbol.iterator]() Gets a new iterator able to iterate all values in the set in ascending order.
    *
    * WARNING: Is not allowed to change the bitmap while iterating.
    * The iterator may throw exception if the bitmap is changed during the iteration.
@@ -347,7 +389,7 @@ export class RoaringBitmap32 implements Iterable<number> {
   public [Symbol.iterator](): RoaringBitmap32Iterator
 
   /**
-   * Gets a new iterator able to iterate all values in the set in order.
+   * Gets a new iterator able to iterate all values in the set in ascending order.
    *
    * WARNING: Is not allowed to change the bitmap while iterating.
    * The iterator may throw exception if the bitmap is changed during the iteration.
@@ -359,6 +401,56 @@ export class RoaringBitmap32 implements Iterable<number> {
    */
   public iterator(): RoaringBitmap32Iterator
 
+  /**
+   * Gets a new iterator able to iterate all values in the set in ascending order.
+   * This is just for compatibility with the Set<number> interface.
+   *
+   * WARNING: Is not allowed to change the bitmap while iterating. Undefined behaviour.
+   * The iterator may throw exception if the bitmap is changed during the iteration.
+   *
+   * Same as [Symbol.iterator]()
+   *
+   * @returns {RoaringBitmap32Iterator} A new iterator
+   * @memberof RoaringBitmap32
+   */
+  public keys(): RoaringBitmap32Iterator
+
+  /**
+   * Gets a new iterator able to iterate all values in the set in ascending order.
+   * This is just for compatibility with the Set<number> interface.
+   *
+   * WARNING: Is not allowed to change the bitmap while iterating. Undefined behaviour.
+   * The iterator may throw exception if the bitmap is changed during the iteration.
+   *
+   * Same as [Symbol.iterator]()
+   *
+   * @returns {RoaringBitmap32Iterator} A new iterator
+   * @memberof RoaringBitmap32
+   */
+  public values(): RoaringBitmap32Iterator
+
+  /**
+   * Gets a new iterator able to iterate all value pairs [value, value] in the set in ascending order.
+   * This is just for compatibility with the Set<number> interface.
+   *
+   * WARNING: Is not allowed to change the bitmap while iterating. Undefined behaviour.
+   * The iterator may throw exception if the bitmap is changed during the iteration.
+   *
+   * Same as [Symbol.iterator]()
+   *
+   * @returns {RoaringBitmap32Iterator} A new iterator
+   * @memberof RoaringBitmap32
+   */
+  public entries(): IterableIterator<[number, number]>
+
+  /**
+   * Executes a function for each value in the set, in ascending order.
+   * The callback has 3 arguments, the value, the value and this (this set). This is to match the Set<number> interface.
+   *
+   * WARNING: Is not allowed to change the bitmap while iterating. Undefined behaviour.
+   */
+  public forEach(callbackfn: (value: number, value2: number, set: this) => void, thisArg?: any): void
+
   /**
    * Gets the minimum value in the set.
    *
@@ -862,6 +954,16 @@ export class RoaringBitmap32 implements Iterable<number> {
    */
   public clone(): RoaringBitmap32
 
+  /**
+   * Returns always "RoaringBitmap32".
+   *
+   * To have a standard string representation of the content as a string, call contentToString() instead.
+   *
+   * @returns {string} "RoaringBitmap32"
+   * @memberof RoaringBitmap32
+   */
+  readonly [Symbol.toStringTag]: string
+
   /**
    * Returns always "RoaringBitmap32".
    *
@@ -1047,7 +1149,7 @@ export interface RoaringBitmap32Statistics {
 
 /**
  * Property: The version of the CRoaring libary as a string.
- * Example: "0.2.42"
+ * Example: "0.4.0"
  *
  * @export
  * @constant
@@ -1058,7 +1160,7 @@ export const CRoaringVersion: string
 
 /**
  * Property: The version of the roaring npm package as a string.
- * Example: "0.2.2"
+ * Example: "1.2.0"
  *
  * @export
  * @constant