pict-section-formeditor 1.0.0

package/user-documentation/solverfunctions/linest.md

@@ -0,0 +1,58 @@
+# linest
+
+Performs linear estimation (alias for leastsquares).
+
+## Syntax
+
+```
+linest(xValues, yValues)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `xValues` | Array | Array of x-coordinates (independent variable) |
+| `yValues` | Array | Array of y-coordinates (dependent variable) |
+
+## Returns
+
+Object - Regression results including slope, intercept, and statistics.
+
+## Description
+
+The `linest` function is an alias for `leastsquares`, performing linear regression to find the best-fit line through data points. Named after the Excel LINEST function.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = LINEST([1, 2, 3, 4, 5], [2, 4, 6, 8, 10])
+// Returns: { slope: 2, intercept: 0, ... }
+```
+
+### Spreadsheet-Style Usage
+
+```expression
+// Similar to Excel LINEST
+Regression = LINEST(IndependentData, DependentData)
+```
+
+## Use Cases
+
+- **Spreadsheet compatibility**: Excel-like function
+- **Trend analysis**: Linear trends
+- **Forecasting**: Project values
+
+## Related Functions
+
+- [leastsquares](./leastsquares.md) - Same function, different name
+- [polynomialregression](./polynomialregression.md) - Higher-order regression
+- [predict](./predict.md) - Predict using results
+
+## Notes
+
+- Alias for `leastsquares`
+- Excel-compatible naming
+- Uses the Math service's `leastSquares` method

package/user-documentation/solverfunctions/log.md

@@ -0,0 +1,74 @@
+# log
+
+Calculates the natural logarithm (base e) of a number.
+
+## Syntax
+
+```
+log(value)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `value` | Number | The number to calculate the logarithm of |
+
+## Returns
+
+Number - The natural logarithm of the input value.
+
+## Description
+
+The `log` function calculates the natural logarithm (ln) of a number. The natural logarithm uses Euler's number (e ≈ 2.71828) as its base.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = LOG(10)
+// Result: 2.302585092994046 (approximately)
+```
+
+### Logarithm of e
+
+```expression
+Result = LOG(EULER())
+// Result: 1
+```
+
+### With Variables
+
+```expression
+LogValue = LOG(InputNumber)
+```
+
+### Inverse of exp
+
+```expression
+// LOG and EXP are inverse functions
+Original = 5
+Transformed = LOG(EXP(Original))
+// Transformed ≈ 5
+```
+
+## Use Cases
+
+- **Growth analysis**: Logarithmic scaling of data
+- **Scientific calculations**: Mathematical modeling
+- **Data transformation**: Normalizing skewed data
+- **Financial calculations**: Compound interest analysis
+
+## Related Functions
+
+- [exp](./exp.md) - Inverse function (e^x)
+- [euler](./euler.md) - Euler's number constant
+- [sqrt](./sqrt.md) - Square root
+
+## Notes
+
+- Returns NaN for negative numbers
+- Returns -Infinity for 0
+- Uses JavaScript's `Math.log` internally
+- LOG(1) = 0

package/user-documentation/solverfunctions/logvalues.md

@@ -0,0 +1,65 @@
+# logvalues
+
+Logs values to the browser console and returns the last value. Useful for debugging solver expressions.
+
+## Syntax
+
+```
+logvalues(val1, val2, ...)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `val1` | Any | First value to log |
+| `val2` | Any | Second value to log |
+| `...` | Any | Additional values to log |
+
+## Returns
+
+The last value passed to the function.
+
+## Description
+
+The `logvalues` function outputs each of its arguments to the browser developer console, then returns the last argument. This is primarily a debugging tool that lets you inspect intermediate values in solver expressions without disrupting the expression chain. Since it returns the last value, it can be inserted into expressions to observe values at any point during evaluation.
+
+## Examples
+
+### Debugging a calculation
+
+```expression
+Debug = logvalues(Price, Quantity, Total)
+// Logs Price, Quantity, and Total to the console; Debug is set to Total
+```
+
+### Inspecting a single value
+
+```expression
+Check = logvalues(SomeComputedValue)
+// Logs SomeComputedValue to the console and returns it
+```
+
+### Tracing multiple intermediate values
+
+```expression
+Trace = logvalues("Step1", RawPrice, "Step2", AdjustedPrice, "Final", FinalPrice)
+// Logs all six arguments; Trace is set to FinalPrice
+```
+
+## Use Cases
+
+- **Debugging solvers**: Inspect values during solver execution to verify correctness of intermediate calculations
+- **Tracing data flow**: Log multiple related values to understand how data flows through expressions
+- **Temporary inspection**: Drop into an expression temporarily to check a value, then remove when done
+
+## Related Functions
+
+- [setvalue](./setvalue.md) - Sets a value in the application state
+
+## Notes
+
+- Accepts any number of arguments
+- Always returns the last argument passed
+- Output appears in the browser developer console (open with F12 or Ctrl+Shift+I)
+- Intended for development and debugging; consider removing from production solver expressions

package/user-documentation/solverfunctions/match.md

@@ -0,0 +1,71 @@
+# match
+
+Tests a string against a regular expression pattern.
+
+## Syntax
+
+```
+match(text, pattern)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `text` | String | The string to test |
+| `pattern` | String | Regular expression pattern |
+
+## Returns
+
+Boolean - True if the pattern matches, false otherwise.
+
+## Description
+
+The `match` function tests whether a string matches a regular expression pattern. Returns true if the pattern is found anywhere in the string.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = MATCH("Hello World", "World")
+// Result: true
+```
+
+### Email Validation
+
+```expression
+IsEmail = MATCH(InputValue, "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$")
+```
+
+### Phone Number Pattern
+
+```expression
+IsPhone = MATCH(PhoneNumber, "^\\d{3}-\\d{3}-\\d{4}$")
+```
+
+### Contains Digit
+
+```expression
+HasDigit = MATCH(Password, "\\d")
+```
+
+## Use Cases
+
+- **Validation**: Validate input formats
+- **Pattern matching**: Find patterns in text
+- **Filtering**: Conditional processing
+- **Data quality**: Check data format
+
+## Related Functions
+
+- [findfirstvaluebyexactmatch](./findfirstvaluebyexactmatch.md) - Find in array
+- [findfirstvaluebystringincludes](./findfirstvaluebystringincludes.md) - Substring search
+- [if](./if.md) - Use with conditional logic
+
+## Notes
+
+- Uses JavaScript regex
+- Escape special characters with double backslash
+- Returns boolean
+- Uses the Utility service's `legacyMatch` method

package/user-documentation/solverfunctions/matrixinverse.md

@@ -0,0 +1,67 @@
+# matrixinverse
+
+Calculates the inverse of a square matrix.
+
+## Syntax
+
+```
+matrixinverse(matrix)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `matrix` | Array | Square matrix (n×n) |
+
+## Returns
+
+Array - The inverse matrix.
+
+## Description
+
+The `matrixinverse` function calculates the inverse of a square matrix. The inverse matrix A⁻¹ satisfies A × A⁻¹ = I (identity matrix).
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Matrix: [[4, 7], [2, 6]]
+Result = MATRIXINVERSE([[4, 7], [2, 6]])
+// Result: [[0.6, -0.7], [-0.2, 0.4]]
+```
+
+### 3x3 Matrix
+
+```expression
+Matrix3x3 = [[1, 2, 3], [0, 1, 4], [5, 6, 0]]
+Inverse = MATRIXINVERSE(Matrix3x3)
+```
+
+### Solving Equations
+
+```expression
+// Solve Ax = b  →  x = A⁻¹b
+Solution = MATRIXVECTORMULTIPLY(MATRIXINVERSE(A), B)
+```
+
+## Use Cases
+
+- **Solving linear systems**: Find solutions to Ax = b
+- **Transformations**: Reverse transformations
+- **Regression**: Part of least squares solution
+- **Control systems**: System analysis
+
+## Related Functions
+
+- [matrixmultiply](./matrixmultiply.md) - Verify inverse
+- [gaussianelimination](./gaussianelimination.md) - Alternative solver
+- [matrixtranspose](./matrixtranspose.md) - Transpose matrix
+
+## Notes
+
+- Matrix must be square
+- Matrix must be invertible (non-singular)
+- Throws error for singular matrices
+- Uses the Math service's `matrixInverse` method

package/user-documentation/solverfunctions/matrixmultiply.md

@@ -0,0 +1,71 @@
+# matrixmultiply
+
+Multiplies two matrices together.
+
+## Syntax
+
+```
+matrixmultiply(matrix1, matrix2)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `matrix1` | Array | First matrix (m×n) |
+| `matrix2` | Array | Second matrix (n×p) |
+
+## Returns
+
+Array - The resulting matrix (m×p).
+
+## Description
+
+The `matrixmultiply` function performs matrix multiplication of two matrices. The number of columns in the first matrix must equal the number of rows in the second matrix.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// A = [[1, 2], [3, 4]]
+// B = [[5, 6], [7, 8]]
+Result = MATRIXMULTIPLY([[1, 2], [3, 4]], [[5, 6], [7, 8]])
+// Result: [[19, 22], [43, 50]]
+```
+
+### Different Dimensions
+
+```expression
+// 2x3 matrix times 3x2 matrix
+A = [[1, 2, 3], [4, 5, 6]]
+B = [[7, 8], [9, 10], [11, 12]]
+Result = MATRIXMULTIPLY(A, B)
+// Result: 2x2 matrix
+```
+
+### Transformation
+
+```expression
+// Apply transformation matrix
+Transformed = MATRIXMULTIPLY(TransformMatrix, DataMatrix)
+```
+
+## Use Cases
+
+- **Linear algebra**: Matrix computations
+- **Transformations**: Apply linear transforms
+- **Systems of equations**: Solve matrix equations
+- **Computer graphics**: Coordinate transformations
+
+## Related Functions
+
+- [matrixtranspose](./matrixtranspose.md) - Transpose matrix
+- [matrixvectormultiply](./matrixvectormultiply.md) - Matrix-vector multiplication
+- [matrixinverse](./matrixinverse.md) - Matrix inverse
+
+## Notes
+
+- Dimensions must be compatible (m×n × n×p = m×p)
+- Not commutative (A×B ≠ B×A generally)
+- Uses the Math service's `matrixMultiply` method

package/user-documentation/solverfunctions/matrixtranspose.md

@@ -0,0 +1,72 @@
+# matrixtranspose
+
+Transposes a matrix (swaps rows and columns).
+
+## Syntax
+
+```
+matrixtranspose(matrix)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `matrix` | Array | 2D array representing the matrix |
+
+## Returns
+
+Array - The transposed matrix.
+
+## Description
+
+The `matrixtranspose` function swaps the rows and columns of a matrix. Element at position [i][j] moves to position [j][i].
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Given matrix:
+// [[1, 2, 3],
+//  [4, 5, 6]]
+Result = MATRIXTRANSPOSE([[1, 2, 3], [4, 5, 6]])
+// Result:
+// [[1, 4],
+//  [2, 5],
+//  [3, 6]]
+```
+
+### Square Matrix
+
+```expression
+Matrix = [[1, 2], [3, 4]]
+Transposed = MATRIXTRANSPOSE(Matrix)
+// Result: [[1, 3], [2, 4]]
+```
+
+### Data Orientation
+
+```expression
+// Convert row-oriented data to column-oriented
+ColumnData = MATRIXTRANSPOSE(RowData)
+```
+
+## Use Cases
+
+- **Linear algebra**: Matrix operations
+- **Data transformation**: Row/column conversion
+- **Statistical analysis**: Data orientation
+- **Grid manipulation**: Rotate data structure
+
+## Related Functions
+
+- [matrixmultiply](./matrixmultiply.md) - Multiply matrices
+- [matrixinverse](./matrixinverse.md) - Invert matrix
+- [matrixvectormultiply](./matrixvectormultiply.md) - Matrix-vector multiplication
+
+## Notes
+
+- 2x3 matrix becomes 3x2 matrix
+- Works with rectangular matrices
+- Uses the Math service's `matrixTranspose` method

package/user-documentation/solverfunctions/matrixvectormultiply.md

@@ -0,0 +1,69 @@
+# matrixvectormultiply
+
+Multiplies a matrix by a vector.
+
+## Syntax
+
+```
+matrixvectormultiply(matrix, vector)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `matrix` | Array | 2D array representing the matrix (m×n) |
+| `vector` | Array | 1D array representing the vector (length n) |
+
+## Returns
+
+Array - The resulting vector (length m).
+
+## Description
+
+The `matrixvectormultiply` function multiplies a matrix by a column vector. The vector length must equal the number of columns in the matrix.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Matrix: [[1, 2], [3, 4]]
+// Vector: [5, 6]
+Result = MATRIXVECTORMULTIPLY([[1, 2], [3, 4]], [5, 6])
+// Result: [17, 39]
+// [1*5 + 2*6, 3*5 + 4*6] = [17, 39]
+```
+
+### Transformation
+
+```expression
+// Apply transformation to point
+NewPoint = MATRIXVECTORMULTIPLY(RotationMatrix, Point)
+```
+
+### Linear Combination
+
+```expression
+// Compute linear combination of basis vectors
+Result = MATRIXVECTORMULTIPLY(BasisMatrix, Coefficients)
+```
+
+## Use Cases
+
+- **Linear transformations**: Apply transforms to points
+- **Solving equations**: Part of solving Ax = b
+- **Graphics**: Coordinate transformations
+- **Physics**: Linear operations
+
+## Related Functions
+
+- [matrixmultiply](./matrixmultiply.md) - Matrix-matrix multiplication
+- [matrixtranspose](./matrixtranspose.md) - Transpose matrix
+- [matrixinverse](./matrixinverse.md) - Matrix inverse
+
+## Notes
+
+- Vector treated as column vector
+- Vector length must match matrix columns
+- Uses the Math service's `matrixVectorMultiply` method

package/user-documentation/solverfunctions/max.md

@@ -0,0 +1,73 @@
+# max
+
+Returns the largest value from a set of numbers.
+
+## Syntax
+
+```
+max(value1, value2, ...)
+max(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Number(s) | Individual numbers or an array of numbers |
+
+## Returns
+
+String - The maximum value from the input set.
+
+## Description
+
+The `max` function finds and returns the largest value from a set of numbers. It can accept individual arguments or an array of values.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = MAX(5, 10, 3, 8)
+// Result: "10"
+```
+
+### With Variables
+
+```expression
+Highest = MAX(Score1, Score2, Score3)
+```
+
+### With Array
+
+```expression
+// Given an array of values
+MaxValue = MAX(AppData.Scores)
+```
+
+### In Expressions
+
+```expression
+// Find the highest price
+MaxPrice = MAX(FLATTEN(AppData.Products.price))
+```
+
+## Use Cases
+
+- **Data analysis**: Find highest values in datasets
+- **Pricing**: Determine maximum price
+- **Scoring**: Find top scores
+- **Limits**: Establish upper bounds
+
+## Related Functions
+
+- [min](./min.md) - Find minimum value
+- [largestinset](./largestinset.md) - Alternative for finding largest
+- [sortset](./sortset.md) - Sort values to find extremes
+- [avg](./avg.md) - Calculate average
+
+## Notes
+
+- Returns result as string (arbitrary precision)
+- Works with the Math service's `maxPrecise` method
+- Handles both individual arguments and arrays

package/user-documentation/solverfunctions/mean.md

@@ -0,0 +1,63 @@
+# mean
+
+Calculates the arithmetic mean (average) of values.
+
+## Syntax
+
+```
+mean(value1, value2, ...)
+mean(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Number(s) | Individual numbers or an array of numbers |
+
+## Returns
+
+String - The arithmetic mean.
+
+## Description
+
+The `mean` function calculates the arithmetic mean (average) of a set of numbers. This is an alias for the `avg` function.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = MEAN(10, 20, 30, 40, 50)
+// Result: "30"
+```
+
+### With Array
+
+```expression
+Average = MEAN(FLATTEN(AppData.Scores))
+```
+
+### Statistics
+
+```expression
+MeanValue = MEAN(DataSet)
+```
+
+## Use Cases
+
+- **Statistics**: Central tendency
+- **Analysis**: Average values
+- **Reporting**: Mean calculations
+
+## Related Functions
+
+- [avg](./avg.md) - Same function (alias)
+- [median](./median.md) - Middle value
+- [mode](./mode.md) - Most frequent value
+
+## Notes
+
+- Alias for `avg` function
+- Uses the Math service's `meanPrecise` method
+- Returns result as string for precision