pict-section-formeditor 1.0.0

package/user-documentation/solverfunctions/stringgetsegments.md

@@ -0,0 +1,74 @@
+# stringgetsegments
+
+Splits a string into segments by a delimiter.
+
+## Syntax
+
+```
+stringgetsegments(text, delimiter)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `text` | String | The string to split |
+| `delimiter` | String | The delimiter to split by |
+
+## Returns
+
+Array - Array of string segments.
+
+## Description
+
+The `stringgetsegments` function splits a string by a specified delimiter and returns an array of the resulting segments.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = STRINGGETSEGMENTS("a,b,c,d,e", ",")
+// Result: ["a", "b", "c", "d", "e"]
+```
+
+### Path Parsing
+
+```expression
+PathParts = STRINGGETSEGMENTS("/home/user/documents", "/")
+// Result: ["", "home", "user", "documents"]
+```
+
+### Data Extraction
+
+```expression
+Fields = STRINGGETSEGMENTS(CSVLine, ",")
+// Returns array of field values
+```
+
+### Get Specific Segment
+
+```expression
+// Get second segment
+Segments = STRINGGETSEGMENTS(Data, ",")
+SecondItem = Segments[1]
+```
+
+## Use Cases
+
+- **CSV parsing**: Split delimited lines
+- **Path processing**: Extract path components
+- **Data parsing**: Split structured strings
+- **Text processing**: Tokenize text
+
+## Related Functions
+
+- [stringcountsegments](./stringcountsegments.md) - Count segments
+- [join](./join.md) - Reverse operation (join segments)
+- [slice](./slice.md) - Get subset of segments
+
+## Notes
+
+- Returns array of strings
+- Empty between delimiters creates empty string
+- Uses the Utility service

package/user-documentation/solverfunctions/subtractingsummation.md

@@ -0,0 +1,66 @@
+# subtractingsummation
+
+Generates a subtracting running total from an array of values.
+
+## Syntax
+
+```
+subtractingsummation(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `array` | Array | Array of numeric values |
+
+## Returns
+
+Array - Array of running differences.
+
+## Description
+
+The `subtractingsummation` function creates an array where each element is the result of subtracting subsequent values from a running total. This is the opposite of cumulative summation.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = SUBTRACTINGSUMMATION([100, 20, 30, 10])
+// Result: [100, 80, 50, 40]
+// 100, 100-20=80, 80-30=50, 50-10=40
+```
+
+### Budget Tracking
+
+```expression
+// Start with budget, subtract expenses
+RemainingBudget = SUBTRACTINGSUMMATION([1000, 250, 150, 75, 200])
+// Shows remaining after each expense
+```
+
+### Inventory Depletion
+
+```expression
+InventoryLevels = SUBTRACTINGSUMMATION([500, 50, 30, 100, 25])
+```
+
+## Use Cases
+
+- **Budget tracking**: Remaining funds after expenses
+- **Inventory**: Stock levels after withdrawals
+- **Resource depletion**: Tracking consumption
+- **Countdown**: Decreasing totals
+
+## Related Functions
+
+- [cumulativesummation](./cumulativesummation.md) - Running total (adding)
+- [sum](./sum.md) - Simple sum
+- [iterativeseries](./iterativeseries.md) - Custom iterative calculation
+
+## Notes
+
+- First element is starting value
+- Each subsequent element subtracts from running total
+- Uses the Math service's `subtractingSummation` method

package/user-documentation/solverfunctions/sum.md

@@ -0,0 +1,78 @@
+# sum
+
+Calculates the sum of all values in a set.
+
+## Syntax
+
+```
+sum(array)
+sum(value1, value2, ...)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `array` | Array | An array of numeric values |
+| `values` | Numbers | Individual values to sum |
+
+## Returns
+
+String - The sum of all values with arbitrary precision.
+
+## Description
+
+The `sum` function adds up all numeric values in an array or set of arguments. It uses arbitrary precision arithmetic for accurate calculations.
+
+## Examples
+
+### Basic Array Sum
+
+```expression
+TotalCost = SUM(ItemCosts)
+// With ItemCosts = [100, 200, 50, 45, 5]
+// Result: "400"
+```
+
+### Sum with Flattened Arrays
+
+```expression
+// Sum population from nested data
+PopSum = sum(flatten(AppData.Cities[].population))
+// Sums all population values from the Cities array
+```
+
+### Sum of Histogram Values
+
+```expression
+// Sum aggregated values
+Total = SUM(FLATTEN(AppData.DestinationObject.AggregationResult))
+```
+
+### Combining with Other Functions
+
+```expression
+// Sum a computed series
+IntegratedSeries = SUM(FLATTEN(AppData.SeriesFromCoefficients))
+```
+
+## Use Cases
+
+- **Financial totals**: Sum of transactions, costs, revenues
+- **Inventory**: Total quantity of items
+- **Statistics**: First step in many statistical calculations
+- **Aggregation**: Combining values from multiple sources
+
+## Related Functions
+
+- [avg](./avg.md) / [mean](./mean.md) - Calculate average
+- [count](./count.md) - Count elements
+- [min](./min.md) / [max](./max.md) - Find extremes
+- [cumulativesummation](./cumulativesummation.md) - Running total
+
+## Notes
+
+- Uses arbitrary precision arithmetic
+- Returns "0" for empty arrays
+- Non-numeric values may be treated as 0
+- Works with the Math service's `sumPrecise` method

package/user-documentation/solverfunctions/tan.md

@@ -0,0 +1,78 @@
+# tan
+
+Calculates the tangent of an angle (in radians).
+
+## Syntax
+
+```
+tan(radians)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `radians` | Number/String | The angle in radians |
+
+## Returns
+
+String - The tangent of the angle.
+
+## Description
+
+The `tan` function calculates the tangent of an angle, which equals sin(angle)/cos(angle). The input must be in radians. Use the `rad()` function to convert degrees to radians if needed.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = tan(0)
+// Result: "0"
+
+Result = tan(0.7853981633974483)  // π/4 (45 degrees)
+// Result: "1" (approximately)
+```
+
+### Converting from Degrees
+
+```expression
+// Tangent of 45 degrees
+Result = tan(rad(45))
+// Result: "1"
+
+// Tangent of 30 degrees
+Result = tan(rad(30))
+// Result: "0.5773502691896257"
+```
+
+### Slope Calculations
+
+```expression
+// Calculate slope from angle
+Slope = tan(rad(AngleDegrees))
+
+// Rise over run
+Rise = Run * tan(Angle)
+```
+
+## Use Cases
+
+- **Trigonometry**: Slope and angle calculations
+- **Surveying**: Elevation changes
+- **Physics**: Incline problems
+- **Graphics**: Perspective calculations
+
+## Related Functions
+
+- [sin](./sin.md) - Sine
+- [cos](./cos.md) - Cosine
+- [rad](./rad.md) - Convert degrees to radians
+- [pi](./pi.md) - Pi constant
+
+## Notes
+
+- Input must be in radians, not degrees
+- Use `rad(degrees)` to convert from degrees
+- Tangent is undefined at 90°, 270°, etc. (π/2, 3π/2, ...)
+- Uses JavaScript's `Math.tan()` internally

package/user-documentation/solverfunctions/tofixed.md

@@ -0,0 +1,75 @@
+# tofixed
+
+Formats a number with a specified number of decimal places.
+
+## Syntax
+
+```
+tofixed(value, decimalPlaces)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `value` | Number | The number to format |
+| `decimalPlaces` | Number | Number of decimal places to display |
+
+## Returns
+
+String - The number formatted with the specified decimal places.
+
+## Description
+
+The `tofixed` function formats a number to a fixed number of decimal places. This is useful for displaying currency, percentages, and other formatted numeric values.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = TOFIXED(3.14159, 2)
+// Result: "3.14"
+```
+
+### Currency Formatting
+
+```expression
+Price = TOFIXED(19.9, 2)
+// Result: "19.90"
+```
+
+### Rounding
+
+```expression
+Result = TOFIXED(2.567, 1)
+// Result: "2.6"
+```
+
+### With Calculations
+
+```expression
+// Format a calculated percentage
+FormattedPercent = TOFIXED(PERCENT(Completed, Total) * 100, 1)
+```
+
+## Use Cases
+
+- **Currency display**: Format prices and amounts
+- **Percentage display**: Format percentages with precision
+- **Scientific data**: Consistent decimal places
+- **Reports**: Standardized number formatting
+
+## Related Functions
+
+- [round](./round.md) - Round to nearest integer
+- [floor](./floor.md) - Round down
+- [ceil](./ceil.md) - Round up
+- [percent](./percent.md) - Calculate percentages
+
+## Notes
+
+- Always returns specified number of decimal places
+- Pads with zeros if necessary (19.9 → "19.90")
+- Uses the Math service's `toFixedPrecise` method
+- Returns result as string

package/user-documentation/solverfunctions/unionarrays.md

@@ -0,0 +1,59 @@
+# unionarrays
+
+Returns a new array containing all unique values from both input arrays (set union).
+
+## Syntax
+
+```
+unionarrays(array1, array2)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `array1` | Array | The first array |
+| `array2` | Array | The second array |
+
+## Returns
+
+A new array containing all unique values from both input arrays.
+
+## Description
+
+The `unionarrays` function performs a set union operation on two arrays. It combines both arrays and removes any duplicate values, returning a new array that contains every distinct value present in either input array. This is useful for merging lists while ensuring no value appears more than once.
+
+## Examples
+
+### Combining two teams
+
+```expression
+Combined = unionarrays(TeamA, TeamB)
+// If TeamA is ["Alice", "Bob"] and TeamB is ["Bob", "Carol"],
+// Combined is ["Alice", "Bob", "Carol"]
+```
+
+### Merging selected options
+
+```expression
+AllSelections = unionarrays(PreviousSelections, NewSelections)
+// Combines both selection lists with no duplicates
+```
+
+## Use Cases
+
+- **Merging lists**: Combine two lists of items while eliminating duplicates
+- **Accumulating selections**: Merge newly selected items with previously selected items
+- **Building unique sets**: Create a comprehensive list from multiple sources
+
+## Related Functions
+
+- [differencearrays](./differencearrays.md) - Returns values in one array that are not in another
+- [uniquearray](./uniquearray.md) - Removes duplicates from a single array
+- [sortarray](./sortarray.md) - Returns a sorted copy of an array
+
+## Notes
+
+- Both parameters must be arrays
+- The returned array contains no duplicate values
+- The order of elements in the result is not guaranteed to match either input

package/user-documentation/solverfunctions/uniquearray.md

@@ -0,0 +1,58 @@
+# uniquearray
+
+Returns a new array with duplicate values removed.
+
+## Syntax
+
+```
+uniquearray(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `array` | Array | The array to deduplicate |
+
+## Returns
+
+A new array containing only the unique values from the input array.
+
+## Description
+
+The `uniquearray` function takes an array and returns a new array with all duplicate values removed. Each value in the resulting array appears exactly once. This is useful for cleaning up lists that may contain repeated entries.
+
+## Examples
+
+### Removing duplicate states
+
+```expression
+UniqueStates = uniquearray(AllStates)
+// If AllStates is ["NY", "CA", "NY", "TX", "CA"],
+// UniqueStates is ["NY", "CA", "TX"]
+```
+
+### Deduplicating collected values
+
+```expression
+CleanList = uniquearray(RawInputList)
+// Returns the list with all duplicates removed
+```
+
+## Use Cases
+
+- **Cleaning data**: Remove duplicate entries from a list of collected values
+- **Building option lists**: Create a list of distinct values for dropdowns or selection controls
+- **Preparing data for display**: Ensure a list shown to the user contains no repeated items
+
+## Related Functions
+
+- [unionarrays](./unionarrays.md) - Returns all unique values from both arrays
+- [differencearrays](./differencearrays.md) - Returns values in one array that are not in another
+- [sortarray](./sortarray.md) - Returns a sorted copy of an array
+
+## Notes
+
+- The input must be an array
+- The order of first appearance is generally preserved
+- Comparison is based on value equality

package/user-documentation/solverfunctions/var.md

@@ -0,0 +1,67 @@
+# var
+
+Calculates the variance of a sample dataset.
+
+## Syntax
+
+```
+var(value1, value2, ...)
+var(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Number(s) | Individual numbers or an array of numbers |
+
+## Returns
+
+String - The sample variance.
+
+## Description
+
+The `var` function calculates the variance of a sample dataset using the sample variance formula (dividing by n-1). Variance measures how spread out the values are from the mean.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = VAR(2, 4, 6, 8, 10)
+// Result: "10" (sample variance)
+```
+
+### With Array
+
+```expression
+Variance = VAR(FLATTEN(AppData.Scores))
+```
+
+### Quality Control
+
+```expression
+// Check variance in measurements
+MeasurementVariance = VAR(Measurements)
+```
+
+## Use Cases
+
+- **Quality control**: Measure consistency
+- **Statistics**: Distribution analysis
+- **Finance**: Investment risk
+- **Research**: Data spread analysis
+
+## Related Functions
+
+- [vara](./vara.md) - Variance including text/boolean
+- [varp](./varp.md) - Population variance
+- [stdev](./stdev.md) - Standard deviation
+- [avg](./avg.md) - Mean value
+
+## Notes
+
+- Uses sample variance formula (n-1 divisor)
+- For population variance, use `varp`
+- Returns result as string
+- Uses the Math service's `varPrecise` method

package/user-documentation/solverfunctions/vara.md

@@ -0,0 +1,58 @@
+# vara
+
+Calculates variance including text and boolean values.
+
+## Syntax
+
+```
+vara(value1, value2, ...)
+vara(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Any | Values including numbers, text, and booleans |
+
+## Returns
+
+String - The variance including converted text/boolean values.
+
+## Description
+
+The `vara` function calculates sample variance while treating text as 0 and boolean TRUE as 1, FALSE as 0. This is similar to Excel's VARA function.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = VARA(1, 2, true, false, "text")
+// Text = 0, true = 1, false = 0
+```
+
+### With Mixed Data
+
+```expression
+Variance = VARA(MixedDataArray)
+```
+
+## Use Cases
+
+- **Mixed data**: Variance with non-numeric values
+- **Spreadsheet compatibility**: Excel-like behavior
+- **Survey data**: Handle mixed responses
+
+## Related Functions
+
+- [var](./var.md) - Numeric-only variance
+- [varp](./varp.md) - Population variance
+- [stdeva](./stdeva.md) - Standard deviation with text/boolean
+
+## Notes
+
+- Text values treated as 0
+- TRUE = 1, FALSE = 0
+- Uses sample variance formula (n-1)
+- Uses the Math service's `varaPrecise` method

package/user-documentation/solverfunctions/varp.md

@@ -0,0 +1,66 @@
+# varp
+
+Calculates the variance of an entire population.
+
+## Syntax
+
+```
+varp(value1, value2, ...)
+varp(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Number(s) | Individual numbers or an array of numbers |
+
+## Returns
+
+String - The population variance.
+
+## Description
+
+The `varp` function calculates the variance of an entire population using the population variance formula (dividing by n). Use this when your data represents the entire population, not a sample.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = VARP(2, 4, 6, 8, 10)
+// Result: "8" (population variance)
+```
+
+### With Array
+
+```expression
+PopVariance = VARP(FLATTEN(AppData.AllMeasurements))
+```
+
+### Complete Dataset
+
+```expression
+// When you have all values, not a sample
+TotalVariance = VARP(EntireDataset)
+```
+
+## Use Cases
+
+- **Census data**: Complete population statistics
+- **Quality control**: All measurements available
+- **Inventory**: Entire inventory analysis
+- **Deterministic systems**: Complete data known
+
+## Related Functions
+
+- [var](./var.md) - Sample variance
+- [vara](./vara.md) - Variance with text/boolean
+- [stdevp](./stdevp.md) - Population standard deviation
+
+## Notes
+
+- Uses population variance formula (n divisor)
+- For samples, use `var` instead
+- Returns result as string
+- Uses the Math service's `varpPrecise` method