pict-section-formeditor 1.0.0

package/user-documentation/solverfunctions/countsetelements.md

@@ -0,0 +1,63 @@
+# countsetelements
+
+Counts unique elements in a set/array.
+
+## Syntax
+
+```
+countsetelements(set)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `set` | Array | The array to count unique elements from |
+
+## Returns
+
+String - The number of unique elements in the set.
+
+## Description
+
+The `countsetelements` function counts the number of unique (distinct) elements in an array. Duplicate values are only counted once.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = COUNTSETELEMENTS([1, 2, 2, 3, 3, 3, 4])
+// Result: "4" (unique values: 1, 2, 3, 4)
+```
+
+### Unique Categories
+
+```expression
+UniqueCategories = COUNTSETELEMENTS(FLATTEN(AppData.Products.category))
+```
+
+### Distinct Users
+
+```expression
+UniqueUsers = COUNTSETELEMENTS(FLATTEN(AppData.Transactions.userId))
+```
+
+## Use Cases
+
+- **Unique counts**: Count distinct values
+- **Deduplication**: Count after removing duplicates
+- **Analysis**: Cardinality of datasets
+- **Validation**: Verify uniqueness
+
+## Related Functions
+
+- [count](./count.md) - Count all elements (including duplicates)
+- [countset](./countset.md) - Count set elements
+- [distributionhistogram](./distributionhistogram.md) - Count by value
+
+## Notes
+
+- Only counts unique values
+- Duplicates counted once
+- Uses the Math service's `countSetElements` method

package/user-documentation/solverfunctions/createarrayfromabsolutevalues.md

@@ -0,0 +1,63 @@
+# createarrayfromabsolutevalues
+
+Creates an array of absolute values from input values.
+
+## Syntax
+
+```
+createarrayfromabsolutevalues(value1, value2, ...)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Number(s) | Values to convert to absolute values |
+
+## Returns
+
+Array - Array of absolute values.
+
+## Description
+
+The `createarrayfromabsolutevalues` function takes multiple values and returns an array containing the absolute value of each input.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = CREATEARRAYFROMABSOLUTEVALUES(-5, 3, -2, 7, -1)
+// Result: [5, 3, 2, 7, 1]
+```
+
+### With Variables
+
+```expression
+AbsValues = CREATEARRAYFROMABSOLUTEVALUES(Delta1, Delta2, Delta3)
+```
+
+### For Distance Calculations
+
+```expression
+Distances = CREATEARRAYFROMABSOLUTEVALUES(X2-X1, Y2-Y1, Z2-Z1)
+```
+
+## Use Cases
+
+- **Distance calculations**: Absolute differences
+- **Error analysis**: Absolute errors
+- **Data normalization**: Remove negative signs
+- **Magnitude**: Get magnitudes of values
+
+## Related Functions
+
+- [abs](./abs.md) - Single value absolute
+- [flatten](./flatten.md) - Flatten arrays
+- [sum](./sum.md) - Sum the absolute values
+
+## Notes
+
+- Converts all values to positive
+- Returns array, not single value
+- Uses the Math service's `createArrayFromAbsoluteValues` method

package/user-documentation/solverfunctions/createvalueobjectbyhashes.md

@@ -0,0 +1,69 @@
+# createvalueobjectbyhashes
+
+Creates an object from arrays of keys and values.
+
+## Syntax
+
+```
+createvalueobjectbyhashes(keys, values)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `keys` | Array | Array of property names |
+| `values` | Array | Array of values |
+
+## Returns
+
+Object - New object with key-value pairs.
+
+## Description
+
+The `createvalueobjectbyhashes` function creates an object by pairing up arrays of keys and values. Each key is matched with the value at the same index.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Keys = ["name", "age", "city"]
+Values = ["John", 30, "NYC"]
+Result = CREATEVALUEOBJECTBYHASHES(Keys, Values)
+// Result: { name: "John", age: 30, city: "NYC" }
+```
+
+### From Headers and Data
+
+```expression
+Headers = ["id", "product", "price"]
+Row = ["001", "Widget", "9.99"]
+Record = CREATEVALUEOBJECTBYHASHES(Headers, Row)
+```
+
+### Dynamic Object Creation
+
+```expression
+PropertyNames = OBJECTKEYSTOARRAY(Template)
+PropertyValues = GeneratedValues
+NewObject = CREATEVALUEOBJECTBYHASHES(PropertyNames, PropertyValues)
+```
+
+## Use Cases
+
+- **CSV processing**: Convert rows to objects
+- **Data transformation**: Build objects dynamically
+- **Mapping**: Create lookup tables
+- **Import**: Convert flat data to objects
+
+## Related Functions
+
+- [objectkeystoarray](./objectkeystoarray.md) - Extract keys
+- [objectvaluestoarray](./objectvaluestoarray.md) - Extract values
+- [generatearrayofobjectsfromsets](./generatearrayofobjectsfromsets.md) - Generate multiple objects
+
+## Notes
+
+- Arrays should have same length
+- Uses the Logic service's `createValueObjectByHashes` method

package/user-documentation/solverfunctions/cumulativesummation.md

@@ -0,0 +1,96 @@
+# cumulativesummation
+
+Calculates cumulative (running) sums across a set of records.
+
+## Syntax
+
+```
+cumulativesummation(array, valueProperty, resultProperty)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `array` | Array | Array of objects to process |
+| `valueProperty` | String | Property name containing values to sum |
+| `resultProperty` | String | Property name to store the cumulative result |
+
+## Returns
+
+Array - The input array with a new property added to each object containing the cumulative sum.
+
+## Description
+
+The `cumulativesummation` function iterates through an array of objects and calculates a running total. Each object receives a new property containing the sum of all values up to and including that point.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Input data
+Data = [
+    { Value: 10 },
+    { Value: 20 },
+    { Value: 5 }
+]
+
+Result = cumulativesummation(Data, "Value", "RunningTotal")
+
+// Result:
+// [
+//     { Value: 10, RunningTotal: "10" },
+//     { Value: 20, RunningTotal: "30" },
+//     { Value: 5, RunningTotal: "35" }
+// ]
+```
+
+### Financial Running Balance
+
+```expression
+// Track cumulative spending
+Transactions = [
+    { Amount: 100, Description: "Purchase 1" },
+    { Amount: 50, Description: "Purchase 2" },
+    { Amount: 75, Description: "Purchase 3" }
+]
+
+Result = cumulativesummation(Transactions, "Amount", "TotalSpent")
+// TotalSpent values: 100, 150, 225
+```
+
+### Inventory Tracking
+
+```expression
+// Track cumulative inventory received
+Shipments = [
+    { Quantity: 500 },
+    { Quantity: 300 },
+    { Quantity: 200 }
+]
+
+Result = cumulativesummation(Shipments, "Quantity", "TotalReceived")
+// TotalReceived values: 500, 800, 1000
+```
+
+## Use Cases
+
+- **Financial tracking**: Running balances, cumulative spending
+- **Inventory management**: Cumulative receipts or shipments
+- **Progress tracking**: Cumulative completion amounts
+- **Statistical analysis**: Cumulative distribution functions
+- **Reporting**: Year-to-date totals
+
+## Related Functions
+
+- [subtractingsummation](./subtractingsummation.md) - Subtracting cumulative
+- [iterativeseries](./iterativeseries.md) - General iterative operations
+- [sum](./sum.md) - Simple sum of all values
+
+## Notes
+
+- Modifies the input array by adding the result property
+- Uses arbitrary precision arithmetic
+- Works with the Math service's `cumulativeSummation` method
+- The result property values are strings (arbitrary precision)

package/user-documentation/solverfunctions/dateadddays.md

@@ -0,0 +1,79 @@
+# dateadddays
+
+Adds a specified number of days to a date.
+
+## Syntax
+
+```
+dateadddays(date, days)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `date` | String | Starting date (ISO 8601 format) |
+| `days` | Number | Number of days to add (can be negative) |
+
+## Returns
+
+String - The resulting date in ISO 8601 format.
+
+## Description
+
+The `dateadddays` function adds a specified number of days to a date and returns the new date. Use negative numbers to subtract days.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATEADDDAYS("2025-04-01T00:00:00.000Z", 10)
+// Result: "2025-04-11T00:00:00.000Z"
+```
+
+### Adding Many Days
+
+```expression
+Result = DATEADDDAYS(DATEFROMPARTS(2025, 4, 1, 13, 03, 51, 761), 87)
+// Result: "2025-06-27T13:03:51.761Z"
+```
+
+### Subtracting Days
+
+```expression
+Result = DATEADDDAYS("2025-04-15T00:00:00.000Z", -10)
+// Result: "2025-04-05T00:00:00.000Z"
+```
+
+### With Variables
+
+```expression
+DueDate = DATEADDDAYS(OrderDate, ShippingDays)
+```
+
+## Use Cases
+
+- **Due date calculation**: Add business days to start date
+- **Scheduling**: Calculate future appointments
+- **Aging reports**: Determine dates in past or future
+- **Date navigation**: Moving through calendars
+
+## Related Functions
+
+- [dateaddmilliseconds](./dateaddmilliseconds.md) - Add milliseconds
+- [dateaddseconds](./dateaddseconds.md) - Add seconds
+- [dateaddminutes](./dateaddminutes.md) - Add minutes
+- [dateaddhours](./dateaddhours.md) - Add hours
+- [dateaddweeks](./dateaddweeks.md) - Add weeks
+- [dateaddmonths](./dateaddmonths.md) - Add months
+- [dateaddyears](./dateaddyears.md) - Add years
+- [datedaydifference](./datedaydifference.md) - Calculate day difference
+- [datefromparts](./datefromparts.md) - Create date from parts
+
+## Notes
+
+- Returns ISO 8601 formatted string
+- Handles month/year boundaries automatically
+- Negative values subtract days
+- Uses the Dates service internally

package/user-documentation/solverfunctions/dateaddhours.md

@@ -0,0 +1,74 @@
+# dateaddhours
+
+Adds a specified number of hours to a date.
+
+## Syntax
+
+```
+dateaddhours(date, hours)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `date` | String | Starting date (ISO 8601 format) |
+| `hours` | Number | Number of hours to add (can be negative) |
+
+## Returns
+
+String - The resulting date in ISO 8601 format.
+
+## Description
+
+The `dateaddhours` function adds a specified number of hours to a date and returns the new date/time. Use negative numbers to subtract hours.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATEADDHOURS("2025-04-01T10:00:00.000Z", 5)
+// Result: "2025-04-01T15:00:00.000Z"
+```
+
+### Crossing Day Boundary
+
+```expression
+Result = DATEADDHOURS("2025-04-01T22:00:00.000Z", 4)
+// Result: "2025-04-02T02:00:00.000Z"
+```
+
+### Subtracting Hours
+
+```expression
+Result = DATEADDHOURS("2025-04-01T10:00:00.000Z", -3)
+// Result: "2025-04-01T07:00:00.000Z"
+```
+
+### Deadline Calculation
+
+```expression
+DeadlineTime = DATEADDHOURS(SubmissionStart, TimeLimit)
+```
+
+## Use Cases
+
+- **SLA tracking**: Hours until deadline
+- **Scheduling**: Appointment times
+- **Time zones**: Hour offset calculations
+- **Shift scheduling**: Work shift end times
+
+## Related Functions
+
+- [dateaddminutes](./dateaddminutes.md) - Add minutes
+- [dateaddseconds](./dateaddseconds.md) - Add seconds
+- [dateadddays](./dateadddays.md) - Add days
+- [datehourdifference](./datehourdifference.md) - Calculate hour difference
+
+## Notes
+
+- Returns ISO 8601 formatted string
+- Handles day/month/year boundaries
+- Negative values subtract hours
+- Uses the Dates service internally

package/user-documentation/solverfunctions/dateaddmilliseconds.md

@@ -0,0 +1,65 @@
+# dateaddmilliseconds
+
+Adds a specified number of milliseconds to a date.
+
+## Syntax
+
+```
+dateaddmilliseconds(date, milliseconds)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `date` | String | Starting date (ISO 8601 format) |
+| `milliseconds` | Number | Number of milliseconds to add (can be negative) |
+
+## Returns
+
+String - The resulting date in ISO 8601 format.
+
+## Description
+
+The `dateaddmilliseconds` function adds a specified number of milliseconds to a date and returns the new date/time. Use negative numbers to subtract milliseconds.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATEADDMILLISECONDS("2025-04-01T10:30:00.000Z", 500)
+// Result: "2025-04-01T10:30:00.500Z"
+```
+
+### Subtracting Milliseconds
+
+```expression
+Result = DATEADDMILLISECONDS("2025-04-01T10:30:00.500Z", -250)
+// Result: "2025-04-01T10:30:00.250Z"
+```
+
+### Precise Timing
+
+```expression
+AnimationFrame = DATEADDMILLISECONDS(StartTime, FrameDelay)
+```
+
+## Use Cases
+
+- **High precision timing**: Millisecond-level calculations
+- **Animation**: Frame timing
+- **Performance measurement**: Precise durations
+- **Logging**: Precise timestamps
+
+## Related Functions
+
+- [dateaddseconds](./dateaddseconds.md) - Add seconds
+- [datemilliseconddifference](./datemilliseconddifference.md) - Calculate millisecond difference
+
+## Notes
+
+- Returns ISO 8601 formatted string
+- Handles second/minute boundaries
+- Negative values subtract milliseconds
+- Uses the Dates service internally

package/user-documentation/solverfunctions/dateaddminutes.md

@@ -0,0 +1,72 @@
+# dateaddminutes
+
+Adds a specified number of minutes to a date.
+
+## Syntax
+
+```
+dateaddminutes(date, minutes)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `date` | String | Starting date (ISO 8601 format) |
+| `minutes` | Number | Number of minutes to add (can be negative) |
+
+## Returns
+
+String - The resulting date in ISO 8601 format.
+
+## Description
+
+The `dateaddminutes` function adds a specified number of minutes to a date and returns the new date/time. Use negative numbers to subtract minutes.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATEADDMINUTES("2025-04-01T10:30:00.000Z", 45)
+// Result: "2025-04-01T11:15:00.000Z"
+```
+
+### Subtracting Minutes
+
+```expression
+Result = DATEADDMINUTES("2025-04-01T10:30:00.000Z", -15)
+// Result: "2025-04-01T10:15:00.000Z"
+```
+
+### Meeting Duration
+
+```expression
+MeetingEnd = DATEADDMINUTES(MeetingStart, Duration)
+```
+
+### Buffer Time
+
+```expression
+ArrivalTime = DATEADDMINUTES(AppointmentTime, -15)
+```
+
+## Use Cases
+
+- **Meeting scheduling**: Calculate end times
+- **Timers**: Add time intervals
+- **Reminders**: Calculate reminder times
+- **Transit**: Estimated arrival times
+
+## Related Functions
+
+- [dateaddseconds](./dateaddseconds.md) - Add seconds
+- [dateaddhours](./dateaddhours.md) - Add hours
+- [dateminutedifference](./dateminutedifference.md) - Calculate minute difference
+
+## Notes
+
+- Returns ISO 8601 formatted string
+- Handles hour/day boundaries
+- Negative values subtract minutes
+- Uses the Dates service internally

package/user-documentation/solverfunctions/dateaddmonths.md

@@ -0,0 +1,74 @@
+# dateaddmonths
+
+Adds a specified number of months to a date.
+
+## Syntax
+
+```
+dateaddmonths(date, months)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `date` | String | Starting date (ISO 8601 format) |
+| `months` | Number | Number of months to add (can be negative) |
+
+## Returns
+
+String - The resulting date in ISO 8601 format.
+
+## Description
+
+The `dateaddmonths` function adds a specified number of months to a date and returns the new date. Use negative numbers to subtract months.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATEADDMONTHS("2025-01-15T00:00:00.000Z", 3)
+// Result: "2025-04-15T00:00:00.000Z"
+```
+
+### Subtracting Months
+
+```expression
+Result = DATEADDMONTHS("2025-06-15T00:00:00.000Z", -2)
+// Result: "2025-04-15T00:00:00.000Z"
+```
+
+### With Variables
+
+```expression
+RenewalDate = DATEADDMONTHS(SubscriptionStart, SubscriptionLength)
+```
+
+### Quarterly Calculations
+
+```expression
+NextQuarter = DATEADDMONTHS(CurrentDate, 3)
+```
+
+## Use Cases
+
+- **Subscriptions**: Calculate renewal dates
+- **Billing cycles**: Monthly billing dates
+- **Project planning**: Monthly milestones
+- **Financial reporting**: Period end dates
+
+## Related Functions
+
+- [dateadddays](./dateadddays.md) - Add days
+- [dateaddweeks](./dateaddweeks.md) - Add weeks
+- [dateaddyears](./dateaddyears.md) - Add years
+- [datemonthdifference](./datemonthdifference.md) - Calculate month difference
+- [datefromparts](./datefromparts.md) - Create date from parts
+
+## Notes
+
+- Returns ISO 8601 formatted string
+- Handles year boundaries automatically
+- Negative values subtract months
+- Uses the Dates service internally