pict-section-formeditor 1.0.0

package/user-documentation/solverfunctions/median.md

@@ -0,0 +1,79 @@
+# median
+
+Returns the middle value of a sorted set.
+
+## Syntax
+
+```
+median(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `array` | Array | An array of numeric values |
+
+## Returns
+
+String - The median value.
+
+## Description
+
+The `median` function returns the middle value when all values are sorted. For an odd number of values, it returns the exact middle value. For an even number of values, it returns the average of the two middle values.
+
+## Examples
+
+### Odd Number of Values
+
+```expression
+TotalCost = MEDIAN(ItemCosts)
+// With ItemCosts = [100, 200, 50, 45, 5]
+// Sorted: [5, 45, 50, 100, 200]
+// Result: "50" (the middle value)
+```
+
+### Even Number of Values
+
+```expression
+Result = median([1, 2, 3, 4])
+// Sorted: [1, 2, 3, 4]
+// Middle values: 2 and 3
+// Result: "2.5" (average of 2 and 3)
+```
+
+### With Variable Data
+
+```expression
+MedianPrice = MEDIAN(Prices)
+// Finds the middle price point
+```
+
+## Use Cases
+
+- **Statistics**: Robust measure of central tendency
+- **Real estate**: Median home prices (less affected by outliers)
+- **Income analysis**: Median income (avoids skew from extremes)
+- **Quality metrics**: Median response time
+
+## Advantages Over Mean
+
+The median is more robust than the mean for skewed data:
+
+```expression
+// Example: [1, 2, 3, 4, 1000]
+Mean = 202     // Heavily influenced by 1000
+Median = 3     // Better represents typical value
+```
+
+## Related Functions
+
+- [avg](./avg.md) / [mean](./mean.md) - Arithmetic average
+- [mode](./mode.md) - Most frequent value
+- [min](./min.md) / [max](./max.md) - Extremes
+
+## Notes
+
+- Values are automatically sorted before finding median
+- Uses arbitrary precision arithmetic
+- Works with the Math service's `medianPrecise` method

package/user-documentation/solverfunctions/min.md

@@ -0,0 +1,73 @@
+# min
+
+Returns the smallest value from a set of numbers.
+
+## Syntax
+
+```
+min(value1, value2, ...)
+min(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Number(s) | Individual numbers or an array of numbers |
+
+## Returns
+
+String - The minimum value from the input set.
+
+## Description
+
+The `min` function finds and returns the smallest value from a set of numbers. It can accept individual arguments or an array of values.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = MIN(5, 10, 3, 8)
+// Result: "3"
+```
+
+### With Variables
+
+```expression
+Lowest = MIN(Price1, Price2, Price3)
+```
+
+### With Array
+
+```expression
+// Given an array of values
+MinValue = MIN(AppData.Temperatures)
+```
+
+### Finding Range
+
+```expression
+// Calculate the range of values
+Range = MAX(Values) - MIN(Values)
+```
+
+## Use Cases
+
+- **Data analysis**: Find lowest values in datasets
+- **Pricing**: Determine minimum price
+- **Quality control**: Find minimum measurements
+- **Limits**: Establish lower bounds
+
+## Related Functions
+
+- [max](./max.md) - Find maximum value
+- [smallestinset](./smallestinset.md) - Alternative for finding smallest
+- [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 `minPrecise` method
+- Handles both individual arguments and arrays

package/user-documentation/solverfunctions/mode.md

@@ -0,0 +1,66 @@
+# mode
+
+Returns the most frequently occurring value in a dataset.
+
+## Syntax
+
+```
+mode(value1, value2, ...)
+mode(array)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `values` | Number(s) | Individual numbers or an array of numbers |
+
+## Returns
+
+String - The value that appears most frequently.
+
+## Description
+
+The `mode` function finds and returns the most frequently occurring value in a dataset. If multiple values have the same highest frequency, it returns one of them.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = MODE(1, 2, 2, 3, 3, 3, 4)
+// Result: "3" (appears 3 times)
+```
+
+### With Array
+
+```expression
+// Find most common value
+MostCommon = MODE(AppData.Ratings)
+```
+
+### Survey Data
+
+```expression
+// Find most selected option
+PopularChoice = MODE(FLATTEN(AppData.Survey.response))
+```
+
+## Use Cases
+
+- **Survey analysis**: Find most common response
+- **Quality control**: Identify most frequent measurement
+- **Market research**: Most popular choice
+- **Statistics**: Central tendency analysis
+
+## Related Functions
+
+- [median](./median.md) - Middle value
+- [avg](./avg.md) - Arithmetic mean
+- [distributionhistogram](./distributionhistogram.md) - Full frequency distribution
+
+## Notes
+
+- Returns result as string
+- Works with the Math service's `modePrecise` method
+- For multimodal datasets, returns one of the modes

package/user-documentation/solverfunctions/objectkeystoarray.md

@@ -0,0 +1,66 @@
+# objectkeystoarray
+
+Extracts all keys from an object as an array.
+
+## Syntax
+
+```
+objectkeystoarray(object)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `object` | Object | The object to extract keys from |
+
+## Returns
+
+Array - Array of all keys from the object.
+
+## Description
+
+The `objectkeystoarray` function returns all property names (keys) from an object as an array. This is useful for iterating over object properties or analyzing object structure.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Given object: { name: "John", age: 30, city: "NYC" }
+Result = OBJECTKEYSTOARRAY(Person)
+// Result: ["name", "age", "city"]
+```
+
+### With Histogram
+
+```expression
+// Get all category names from histogram
+Categories = OBJECTKEYSTOARRAY(CategoryCounts)
+```
+
+### Dynamic Property Access
+
+```expression
+Keys = OBJECTKEYSTOARRAY(ConfigObject)
+// Use keys for iteration or display
+```
+
+## Use Cases
+
+- **Object inspection**: List all properties
+- **Dynamic iteration**: Process unknown objects
+- **Validation**: Check expected properties exist
+- **Display**: Show object structure
+
+## Related Functions
+
+- [objectvaluestoarray](./objectvaluestoarray.md) - Extract values instead
+- [getvalue](./getvalue.md) - Get specific value by key
+- [flatten](./flatten.md) - Flatten arrays
+
+## Notes
+
+- Returns array of strings (key names)
+- Order may not be guaranteed
+- Uses the Math service's `objectKeysToArray` method

package/user-documentation/solverfunctions/objectvaluessortbyexternalobjectarray.md

@@ -0,0 +1,65 @@
+# objectvaluessortbyexternalobjectarray
+
+Sorts object values based on an external ordering array.
+
+## Syntax
+
+```
+objectvaluessortbyexternalobjectarray(object, orderArray, keyProperty)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `object` | Object | Object to sort values from |
+| `orderArray` | Array | Array defining the sort order |
+| `keyProperty` | String | Property to match for ordering |
+
+## Returns
+
+Array - Values sorted according to external order.
+
+## Description
+
+The `objectvaluessortbyexternalobjectarray` function extracts values from an object and sorts them based on the order defined by an external array.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Data = { 'a': 10, 'b': 20, 'c': 30 }
+Order = [{ key: 'c' }, { key: 'a' }, { key: 'b' }]
+
+Result = OBJECTVALUESSORTBYEXTERNALOBJECTARRAY(Data, Order, "key")
+// Result: [30, 10, 20] (sorted: c, a, b)
+```
+
+### Custom Display Order
+
+```expression
+// Sort categories by custom priority
+CategoryData = { 'urgent': 5, 'normal': 10, 'low': 2 }
+Priority = [{ name: 'urgent' }, { name: 'normal' }, { name: 'low' }]
+
+Sorted = OBJECTVALUESSORTBYEXTERNALOBJECTARRAY(CategoryData, Priority, "name")
+```
+
+## Use Cases
+
+- **Custom ordering**: Sort by external criteria
+- **Display order**: Match specific sort order
+- **Prioritization**: Order by priority list
+- **Report generation**: Consistent ordering
+
+## Related Functions
+
+- [sorthistogram](./sorthistogram.md) - Sort by values
+- [sorthistogrambykeys](./sorthistogrambykeys.md) - Sort alphabetically
+- [objectvaluestoarray](./objectvaluestoarray.md) - Extract values
+
+## Notes
+
+- Maintains relationship between keys and values
+- Uses the Math service

package/user-documentation/solverfunctions/objectvaluestoarray.md

@@ -0,0 +1,67 @@
+# objectvaluestoarray
+
+Extracts all values from an object as an array.
+
+## Syntax
+
+```
+objectvaluestoarray(object)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `object` | Object | The object to extract values from |
+
+## Returns
+
+Array - Array of all values from the object.
+
+## Description
+
+The `objectvaluestoarray` function returns all property values from an object as an array. This is useful for aggregating values without needing the keys.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Given object: { name: "John", age: 30, city: "NYC" }
+Result = OBJECTVALUESTOARRAY(Person)
+// Result: ["John", 30, "NYC"]
+```
+
+### Sum Histogram Values
+
+```expression
+// Get all counts from histogram and sum them
+Values = OBJECTVALUESTOARRAY(CategoryCounts)
+Total = SUM(Values)
+```
+
+### Aggregate Processing
+
+```expression
+AllValues = OBJECTVALUESTOARRAY(DataObject)
+Average = AVG(AllValues)
+```
+
+## Use Cases
+
+- **Aggregation**: Sum or average all values
+- **Collection**: Get all values regardless of key
+- **Analysis**: Process all object values
+- **Display**: List all values
+
+## Related Functions
+
+- [objectkeystoarray](./objectkeystoarray.md) - Extract keys instead
+- [flatten](./flatten.md) - Flatten nested arrays
+- [sum](./sum.md) - Sum the extracted values
+
+## Notes
+
+- Returns array of values (any type)
+- Order corresponds to key order
+- Uses the Math service's `objectValuesToArray` method

package/user-documentation/solverfunctions/percent.md

@@ -0,0 +1,75 @@
+# percent
+
+Calculates what percentage one value is of another.
+
+## Syntax
+
+```
+percent(part, whole)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `part` | Number | The partial value |
+| `whole` | Number | The total value |
+
+## Returns
+
+String - The percentage as a decimal (multiply by 100 for traditional percentage).
+
+## Description
+
+The `percent` function calculates what percentage the first value is of the second value. The result is returned as a decimal ratio.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = PERCENT(25, 100)
+// Result: "0.25" (25%)
+```
+
+### Sales Percentage
+
+```expression
+// What percentage of goal was achieved?
+Achievement = PERCENT(ActualSales, SalesGoal)
+```
+
+### With Multiplication for Display
+
+```expression
+// Get traditional percentage value
+PercentValue = PERCENT(50, 200) * 100
+// Result: 25 (25%)
+```
+
+### Completion Rate
+
+```expression
+// Calculate completion percentage
+CompletionRate = PERCENT(CompletedTasks, TotalTasks)
+```
+
+## Use Cases
+
+- **Business metrics**: Calculate achievement percentages
+- **Data analysis**: Proportion calculations
+- **Progress tracking**: Completion percentages
+- **Financial reporting**: Ratio analysis
+
+## Related Functions
+
+- [compare](./compare.md) - Compare two values
+- [round](./round.md) - Round percentage results
+- [tofixed](./tofixed.md) - Format percentage with decimals
+
+## Notes
+
+- Returns decimal, not percentage (0.25 not 25%)
+- Multiply by 100 for traditional percentage display
+- Uses the Math service's `percentPrecise` method
+- Returns result as string for precision

package/user-documentation/solverfunctions/pi.md

@@ -0,0 +1,77 @@
+# pi
+
+Returns the mathematical constant Pi (π) with high precision.
+
+## Syntax
+
+```
+pi()
+```
+
+## Parameters
+
+None.
+
+## Returns
+
+String - Pi to 100 decimal places.
+
+## Description
+
+The `pi` function returns the mathematical constant π (pi), which is the ratio of a circle's circumference to its diameter. The value is provided with 100 decimal places of precision.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = pi()
+// Result: "3.1415926535897932384626433832795028841971693993751058209749445923078164062862089986280348253421170679..."
+```
+
+### Circle Calculations
+
+```expression
+// Circumference of a circle
+Circumference = 2 * pi() * Radius
+
+// Area of a circle
+Area = pi() * Radius^2
+```
+
+### Trigonometry
+
+```expression
+// Convert degrees to radians manually
+Radians = Degrees * pi() / 180
+
+// Or use the rad() function
+Radians = rad(Degrees)
+```
+
+### With Trigonometric Functions
+
+```expression
+// Sine of 90 degrees (π/2 radians)
+Result = sin(pi() / 2)
+// Result: "1" (approximately)
+```
+
+## Use Cases
+
+- **Circle geometry**: Circumference, area, arc length
+- **Trigonometry**: Converting between degrees and radians
+- **Physics**: Wave calculations, oscillations
+- **Engineering**: Rotational calculations
+
+## Related Functions
+
+- [euler](./euler.md) - Euler's number (e)
+- [rad](./rad.md) - Convert degrees to radians
+- [sin](./sin.md), [cos](./cos.md), [tan](./tan.md) - Trigonometric functions
+
+## Notes
+
+- Returns the full precision value stored in the Math service
+- Uses arbitrary precision arithmetic
+- The value is constant and pre-computed

package/user-documentation/solverfunctions/polynomialregression.md

@@ -0,0 +1,69 @@
+# polynomialregression
+
+Fits a polynomial curve to data points.
+
+## Syntax
+
+```
+polynomialregression(xValues, yValues, degree)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `xValues` | Array | Array of x-coordinates |
+| `yValues` | Array | Array of y-coordinates |
+| `degree` | Number | Degree of polynomial to fit |
+
+## Returns
+
+Array - Coefficients of the fitted polynomial.
+
+## Description
+
+The `polynomialregression` function fits a polynomial of specified degree to a set of data points using least squares regression. Returns the coefficients of the polynomial.
+
+## Examples
+
+### Linear Fit (Degree 1)
+
+```expression
+// Fit a line: y = mx + b
+Coefficients = POLYNOMIALREGRESSION([1, 2, 3, 4, 5], [2, 4, 5, 4, 5], 1)
+// Returns [intercept, slope]
+```
+
+### Quadratic Fit (Degree 2)
+
+```expression
+// Fit a parabola: y = ax² + bx + c
+Coefficients = POLYNOMIALREGRESSION(XData, YData, 2)
+// Returns [c, b, a]
+```
+
+### Higher Degree
+
+```expression
+// Fit cubic polynomial
+CubicCoeffs = POLYNOMIALREGRESSION(XValues, YValues, 3)
+```
+
+## Use Cases
+
+- **Trend analysis**: Fit curves to data
+- **Prediction**: Extrapolate from data
+- **Curve fitting**: Model relationships
+- **Scientific analysis**: Data modeling
+
+## Related Functions
+
+- [leastsquares](./leastsquares.md) - Linear least squares
+- [predict](./predict.md) - Predict using coefficients
+- [linest](./linest.md) - Linear estimation
+
+## Notes
+
+- Higher degrees may overfit data
+- Returns array of coefficients
+- Uses the Math service's `polynomialRegression` method

package/user-documentation/solverfunctions/predict.md

@@ -0,0 +1,71 @@
+# predict
+
+Predicts a value using polynomial regression coefficients.
+
+## Syntax
+
+```
+predict(coefficients, xValue)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `coefficients` | Array | Polynomial coefficients from regression |
+| `xValue` | Number | X value to predict for |
+
+## Returns
+
+String - The predicted y-value.
+
+## Description
+
+The `predict` function uses polynomial coefficients (from polynomialregression or similar) to calculate the predicted y-value for a given x-value.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Using linear coefficients [intercept, slope]
+Coefficients = [10, 2]  // y = 2x + 10
+Predicted = PREDICT(Coefficients, 5)
+// Result: "20" (2*5 + 10)
+```
+
+### With Regression Results
+
+```expression
+// First fit the data
+Coeffs = POLYNOMIALREGRESSION(XData, YData, 2)
+// Then predict new values
+FutureValue = PREDICT(Coeffs, NewX)
+```
+
+### Forecasting
+
+```expression
+// Predict future sales
+TrendCoeffs = POLYNOMIALREGRESSION(Months, Sales, 1)
+NextMonthSales = PREDICT(TrendCoeffs, NextMonth)
+```
+
+## Use Cases
+
+- **Forecasting**: Predict future values
+- **Interpolation**: Estimate values between data points
+- **Extrapolation**: Project beyond data range
+- **Modeling**: Apply regression models
+
+## Related Functions
+
+- [polynomialregression](./polynomialregression.md) - Generate coefficients
+- [leastsquares](./leastsquares.md) - Linear regression
+- [linest](./linest.md) - Linear estimation
+
+## Notes
+
+- Uses polynomial evaluation
+- Works with any degree polynomial
+- Uses the Math service's `predict` method