@iiasa/ixmp4-ts 0.4.0 → 0.5.0

package/dist/cjs/dataframe/dataframe.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DType = exports.DataFrame = void 0;
+const exceptions_1 = require("./exceptions");
 /**
  * Represents the available data types for the DataFrame.
  */
@@ -24,7 +25,7 @@ const nonValueIamcColumns = [
     'type',
 ];
 /**
- * Represents a DataFrame, an immutable two-dimensional tabular data structure with labeled axes.
+ * Represents a DataFrame, an immutable two-dimensional row-based tabular data structure with labeled axes.
  */
 class DataFrame {
     /**
@@ -218,6 +219,47 @@ class DataFrame {
     iat(row, column) {
         return this._values[column][row];
     }
+    /**
+     * Executes a query on the DataFrame and returns a new DataFrame containing
+     * the rows that match the specified conditions.
+     * @param query.conditions - A single QueryCondition or an array of QueryCondition objects.
+     * @param query.conjunction - Optional. Specifies how to combine multiple conditions.
+     *                            Can be 'AND' or 'OR'. Defaults to 'AND'.
+     * @returns A new DataFrame containing the rows that match the query.
+     */
+    query(query) {
+        var _a;
+        const conditions = Array.isArray(query.conditions)
+            ? query.conditions
+            : [query.conditions];
+        const conjunction = (_a = query.conjunction) !== null && _a !== void 0 ? _a : 'AND';
+        conditions.forEach((condition) => {
+            if (typeof condition.column === 'string') {
+                condition.column = this._columns.indexOf(condition.column);
+            }
+        });
+        const illegalColumnns = conditions
+            .filter((condition) => condition.column === -1)
+            .map((condition) => condition.column);
+        if (illegalColumnns.length > 0) {
+            throw new exceptions_1.InvalidColumn(illegalColumnns);
+        }
+        const indices = this._values
+            .map((row, i) => {
+            if (conjunction === 'AND') {
+                return conditions.every((condition) => condition.predicate(row[condition.column]))
+                    ? i
+                    : -1;
+            }
+            else {
+                return conditions.some((condition) => condition.predicate(row[condition.column]))
+                    ? i
+                    : -1;
+            }
+        })
+            .filter((i) => i !== -1);
+        return this.iloc({ rows: indices });
+    }
     /**
      * Gets the data type for a specific column.
      * @param column - The column name.

package/dist/cjs/dataframe/exceptions.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidIndex = exports.InvalidColumn = exports.DataFrameError = void 0;
+class DataFrameError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'DataFrameError';
+    }
+}
+exports.DataFrameError = DataFrameError;
+class InvalidColumn extends DataFrameError {
+    constructor(column) {
+        super(`Invalid column: ${Array.isArray(column) ? column.join(', ') : column}`);
+        this.name = 'InvalidColumn';
+    }
+}
+exports.InvalidColumn = InvalidColumn;
+class InvalidIndex extends DataFrameError {
+    constructor(index) {
+        super(`Invalid index: ${Array.isArray(index) ? index.join(', ') : index}`);
+        this.name = 'InvalidIndex';
+    }
+}
+exports.InvalidIndex = InvalidIndex;

package/dist/cjs/dataframe/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.merge = exports.toCsv = exports.toJson = exports.concat = exports.DType = exports.DataFrame = void 0;
+exports.InvalidIndex = exports.InvalidColumn = exports.DataFrameError = exports.merge = exports.toCsv = exports.toJson = exports.concat = exports.DType = exports.DataFrame = void 0;
 var dataframe_1 = require("./dataframe");
 Object.defineProperty(exports, "DataFrame", { enumerable: true, get: function () { return dataframe_1.DataFrame; } });
 Object.defineProperty(exports, "DType", { enumerable: true, get: function () { return dataframe_1.DType; } });
@@ -9,3 +9,7 @@ Object.defineProperty(exports, "concat", { enumerable: true, get: function () {
 Object.defineProperty(exports, "toJson", { enumerable: true, get: function () { return utils_1.toJson; } });
 Object.defineProperty(exports, "toCsv", { enumerable: true, get: function () { return utils_1.toCsv; } });
 Object.defineProperty(exports, "merge", { enumerable: true, get: function () { return utils_1.merge; } });
+var exceptions_1 = require("./exceptions");
+Object.defineProperty(exports, "DataFrameError", { enumerable: true, get: function () { return exceptions_1.DataFrameError; } });
+Object.defineProperty(exports, "InvalidColumn", { enumerable: true, get: function () { return exceptions_1.InvalidColumn; } });
+Object.defineProperty(exports, "InvalidIndex", { enumerable: true, get: function () { return exceptions_1.InvalidIndex; } });

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.merge = exports.toCsv = exports.toJson = exports.concat = exports.DType = exports.DataFrame = exports.InvalidCredentials = exports.BadFilterArguments = exports.InvalidRunMeta = exports.NoDefaultRunVersion = exports.SchemaError = exports.OperationNotSupported = exports.DeletionPrevented = exports.NotUnique = exports.NotFound = exports.Forbidden = exports.InvalidToken = exports.MissingToken = exports.PlatformNotUnique = exports.PlatformNotFound = exports.UnknownApiError = exports.ManagerApiError = exports.ImproperlyConfigured = exports.BadRequest = exports.InconsistentIamcType = exports.ProgrammingError = exports.IxmpError = exports.Platform = void 0;
+exports.InvalidIndex = exports.InvalidColumn = exports.DataFrameError = exports.merge = exports.toCsv = exports.toJson = exports.concat = exports.DType = exports.DataFrame = exports.InvalidCredentials = exports.BadFilterArguments = exports.InvalidRunMeta = exports.NoDefaultRunVersion = exports.SchemaError = exports.OperationNotSupported = exports.DeletionPrevented = exports.NotUnique = exports.NotFound = exports.Forbidden = exports.InvalidToken = exports.MissingToken = exports.PlatformNotUnique = exports.PlatformNotFound = exports.UnknownApiError = exports.ManagerApiError = exports.ImproperlyConfigured = exports.BadRequest = exports.InconsistentIamcType = exports.ProgrammingError = exports.IxmpError = exports.Platform = void 0;
 var platform_1 = require("./core/platform");
 Object.defineProperty(exports, "Platform", { enumerable: true, get: function () { return platform_1.Platform; } });
 var exceptions_1 = require("./core/exceptions");
@@ -32,3 +32,6 @@ Object.defineProperty(exports, "concat", { enumerable: true, get: function () {
 Object.defineProperty(exports, "toJson", { enumerable: true, get: function () { return dataframe_1.toJson; } });
 Object.defineProperty(exports, "toCsv", { enumerable: true, get: function () { return dataframe_1.toCsv; } });
 Object.defineProperty(exports, "merge", { enumerable: true, get: function () { return dataframe_1.merge; } });
+Object.defineProperty(exports, "DataFrameError", { enumerable: true, get: function () { return dataframe_1.DataFrameError; } });
+Object.defineProperty(exports, "InvalidColumn", { enumerable: true, get: function () { return dataframe_1.InvalidColumn; } });
+Object.defineProperty(exports, "InvalidIndex", { enumerable: true, get: function () { return dataframe_1.InvalidIndex; } });

package/dist/esm/dataframe/dataframe.js

@@ -1,3 +1,4 @@
+import { InvalidColumn } from './exceptions';
 /**
  * Represents the available data types for the DataFrame.
  */
@@ -21,7 +22,7 @@ const nonValueIamcColumns = [
     'type',
 ];
 /**
- * Represents a DataFrame, an immutable two-dimensional tabular data structure with labeled axes.
+ * Represents a DataFrame, an immutable two-dimensional row-based tabular data structure with labeled axes.
  */
 class DataFrame {
     _index;
@@ -218,6 +219,46 @@ class DataFrame {
     iat(row, column) {
         return this._values[column][row];
     }
+    /**
+     * Executes a query on the DataFrame and returns a new DataFrame containing
+     * the rows that match the specified conditions.
+     * @param query.conditions - A single QueryCondition or an array of QueryCondition objects.
+     * @param query.conjunction - Optional. Specifies how to combine multiple conditions.
+     *                            Can be 'AND' or 'OR'. Defaults to 'AND'.
+     * @returns A new DataFrame containing the rows that match the query.
+     */
+    query(query) {
+        const conditions = Array.isArray(query.conditions)
+            ? query.conditions
+            : [query.conditions];
+        const conjunction = query.conjunction ?? 'AND';
+        conditions.forEach((condition) => {
+            if (typeof condition.column === 'string') {
+                condition.column = this._columns.indexOf(condition.column);
+            }
+        });
+        const illegalColumnns = conditions
+            .filter((condition) => condition.column === -1)
+            .map((condition) => condition.column);
+        if (illegalColumnns.length > 0) {
+            throw new InvalidColumn(illegalColumnns);
+        }
+        const indices = this._values
+            .map((row, i) => {
+            if (conjunction === 'AND') {
+                return conditions.every((condition) => condition.predicate(row[condition.column]))
+                    ? i
+                    : -1;
+            }
+            else {
+                return conditions.some((condition) => condition.predicate(row[condition.column]))
+                    ? i
+                    : -1;
+            }
+        })
+            .filter((i) => i !== -1);
+        return this.iloc({ rows: indices });
+    }
     /**
      * Gets the data type for a specific column.
      * @param column - The column name.

package/dist/esm/dataframe/exceptions.js

@@ -0,0 +1,18 @@
+export class DataFrameError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'DataFrameError';
+    }
+}
+export class InvalidColumn extends DataFrameError {
+    constructor(column) {
+        super(`Invalid column: ${Array.isArray(column) ? column.join(', ') : column}`);
+        this.name = 'InvalidColumn';
+    }
+}
+export class InvalidIndex extends DataFrameError {
+    constructor(index) {
+        super(`Invalid index: ${Array.isArray(index) ? index.join(', ') : index}`);
+        this.name = 'InvalidIndex';
+    }
+}

package/dist/esm/dataframe/index.js

@@ -1,2 +1,3 @@
 export { DataFrame, DType } from './dataframe';
 export { concat, toJson, toCsv, merge } from './utils';
+export { DataFrameError, InvalidColumn, InvalidIndex } from './exceptions';

package/dist/esm/index.js

@@ -1,3 +1,3 @@
 export { Platform } from './core/platform';
 export { IxmpError, ProgrammingError, InconsistentIamcType, BadRequest, ImproperlyConfigured, ManagerApiError, UnknownApiError, PlatformNotFound, PlatformNotUnique, MissingToken, InvalidToken, Forbidden, NotFound, NotUnique, DeletionPrevented, OperationNotSupported, SchemaError, NoDefaultRunVersion, InvalidRunMeta, BadFilterArguments, InvalidCredentials, } from './core/exceptions';
-export { DataFrame, DType, concat, toJson, toCsv, merge } from './dataframe';
+export { DataFrame, DType, concat, toJson, toCsv, merge, DataFrameError, InvalidColumn, InvalidIndex, } from './dataframe';

package/dist/types/dataframe/dataframe.d.ts

@@ -9,8 +9,12 @@ declare enum DType {
     DATETIME = "datetime",
     MIXED = "mixed"
 }
+export type QueryCondition = {
+    column: string | number;
+    predicate: (value: any) => boolean;
+};
 /**
- * Represents a DataFrame, an immutable two-dimensional tabular data structure with labeled axes.
+ * Represents a DataFrame, an immutable two-dimensional row-based tabular data structure with labeled axes.
  */
 declare class DataFrame {
     private _index;
@@ -122,6 +126,18 @@ declare class DataFrame {
      * @returns The value at the specified row and column.
      */
     iat(row: number, column: number): any;
+    /**
+     * Executes a query on the DataFrame and returns a new DataFrame containing
+     * the rows that match the specified conditions.
+     * @param query.conditions - A single QueryCondition or an array of QueryCondition objects.
+     * @param query.conjunction - Optional. Specifies how to combine multiple conditions.
+     *                            Can be 'AND' or 'OR'. Defaults to 'AND'.
+     * @returns A new DataFrame containing the rows that match the query.
+     */
+    query(query: {
+        conditions: QueryCondition[] | QueryCondition;
+        conjunction?: 'AND' | 'OR';
+    }): DataFrame;
     /**
      * Gets the data type for a specific column.
      * @param column - The column name.

package/dist/types/dataframe/exceptions.d.ts

@@ -0,0 +1,9 @@
+export declare class DataFrameError extends Error {
+    constructor(message: string);
+}
+export declare class InvalidColumn extends DataFrameError {
+    constructor(column: string | number | (string | number)[]);
+}
+export declare class InvalidIndex extends DataFrameError {
+    constructor(index: number | number[]);
+}

package/dist/types/dataframe/index.d.ts

@@ -1,2 +1,3 @@
-export { DataFrame, DType } from './dataframe';
+export { DataFrame, DType, type QueryCondition } from './dataframe';
 export { concat, toJson, toCsv, merge } from './utils';
+export { DataFrameError, InvalidColumn, InvalidIndex } from './exceptions';

package/dist/types/index.d.ts

@@ -21,4 +21,4 @@ export type { TimeSeries as TimeSeriesModel } from './data/iamc/timeseries';
 export type { PlatformInfo as PlatformInfoModel } from './data/info';
 export type { Lookup } from './data/filters';
 export { IxmpError, ProgrammingError, InconsistentIamcType, BadRequest, ImproperlyConfigured, ManagerApiError, UnknownApiError, PlatformNotFound, PlatformNotUnique, MissingToken, InvalidToken, Forbidden, NotFound, NotUnique, DeletionPrevented, OperationNotSupported, SchemaError, NoDefaultRunVersion, InvalidRunMeta, BadFilterArguments, InvalidCredentials, } from './core/exceptions';
-export { DataFrame, DType, concat, toJson, toCsv, merge } from './dataframe';
+export { DataFrame, DType, type QueryCondition, concat, toJson, toCsv, merge, DataFrameError, InvalidColumn, InvalidIndex, } from './dataframe';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iiasa/ixmp4-ts",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
   "description": "typescript client for ixmp4, a data warehouse for scenario analysis",
   "repository": {