pict-section-formeditor 1.0.0

package/user-documentation/solverfunctions/rad.md

@@ -0,0 +1,85 @@
+# rad
+
+Converts degrees to radians.
+
+## Syntax
+
+```
+rad(degrees)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `degrees` | Number/String | The angle in degrees |
+
+## Returns
+
+String - The angle converted to radians.
+
+## Description
+
+The `rad` function converts an angle from degrees to radians. This is necessary because the trigonometric functions (`sin`, `cos`, `tan`) expect angles in radians.
+
+The conversion formula is: radians = degrees × (π / 180)
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = rad(180)
+// Result: "3.14159265358979..." (π)
+
+Result = rad(90)
+// Result: "1.5707963267948966..." (π/2)
+
+Result = rad(360)
+// Result: "6.28318530717958..." (2π)
+```
+
+### With Trigonometric Functions
+
+```expression
+// Sine of 60 degrees
+Result = sin(rad(60))
+// Result: "0.8660254037844386"
+
+// Cosine of 45 degrees
+Result = cos(rad(45))
+// Result: "0.7071067811865476"
+```
+
+### Common Angle Conversions
+
+```expression
+rad(0)    // 0
+rad(30)   // π/6 ≈ 0.5236
+rad(45)   // π/4 ≈ 0.7854
+rad(60)   // π/3 ≈ 1.0472
+rad(90)   // π/2 ≈ 1.5708
+rad(180)  // π ≈ 3.1416
+rad(270)  // 3π/2 ≈ 4.7124
+rad(360)  // 2π ≈ 6.2832
+```
+
+## Use Cases
+
+- **Trigonometry**: Converting user-friendly degree inputs to radians
+- **Graphics**: Rotation calculations
+- **Physics**: Angular motion calculations
+- **Engineering**: Angle-based computations
+
+## Related Functions
+
+- [sin](./sin.md) - Sine (requires radians)
+- [cos](./cos.md) - Cosine (requires radians)
+- [tan](./tan.md) - Tangent (requires radians)
+- [pi](./pi.md) - Pi constant
+
+## Notes
+
+- Uses arbitrary precision arithmetic
+- The result is (degrees × π / 180)
+- Essential for using trig functions with degree-based inputs

package/user-documentation/solverfunctions/randomfloat.md

@@ -0,0 +1,63 @@
+# randomfloat
+
+Generates a random floating-point number.
+
+## Syntax
+
+```
+randomfloat()
+```
+
+## Parameters
+
+None
+
+## Returns
+
+String - A random floating-point number between 0 and 1.
+
+## Description
+
+The `randomfloat` function generates a random decimal number, typically between 0 and 1. This is useful for probability calculations and generating random decimal values.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = RANDOMFLOAT()
+// Result: "0.7423589" (random each time)
+```
+
+### Probability Check
+
+```expression
+// 50% chance
+Happened = RANDOMFLOAT() < 0.5
+```
+
+### Scale to Range
+
+```expression
+// Random value between 0 and 100
+Scaled = RANDOMFLOAT() * 100
+```
+
+## Use Cases
+
+- **Probability**: Random chance calculations
+- **Simulation**: Monte Carlo simulations
+- **Weighting**: Random weighted selection
+- **Testing**: Generate decimal test data
+
+## Related Functions
+
+- [randomfloatbetween](./randomfloatbetween.md) - Random decimal in range
+- [randomfloatupto](./randomfloatupto.md) - Random decimal up to max
+- [randominteger](./randominteger.md) - Random whole number
+
+## Notes
+
+- Returns value between 0 and 1
+- Returns result as string
+- Uses the DataGeneration service

package/user-documentation/solverfunctions/randomfloatbetween.md

@@ -0,0 +1,72 @@
+# randomfloatbetween
+
+Generates a random floating-point number between two values.
+
+## Syntax
+
+```
+randomfloatbetween(min, max)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `min` | Number | Minimum value |
+| `max` | Number | Maximum value |
+
+## Returns
+
+String - A random floating-point number between min and max.
+
+## Description
+
+The `randomfloatbetween` function generates a random decimal number within a specified range.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = RANDOMFLOATBETWEEN(1.0, 10.0)
+// Result: "5.732" (random between 1 and 10)
+```
+
+### Temperature Range
+
+```expression
+RandomTemp = RANDOMFLOATBETWEEN(98.0, 99.5)
+// Random body temperature
+```
+
+### Price Variation
+
+```expression
+RandomPrice = RANDOMFLOATBETWEEN(9.99, 19.99)
+```
+
+### Coordinate Generation
+
+```expression
+RandomLat = RANDOMFLOATBETWEEN(-90, 90)
+RandomLng = RANDOMFLOATBETWEEN(-180, 180)
+```
+
+## Use Cases
+
+- **Simulation**: Random values in realistic ranges
+- **Testing**: Generate bounded decimal test data
+- **Coordinates**: Random geographic coordinates
+- **Pricing**: Random price generation
+
+## Related Functions
+
+- [randomfloat](./randomfloat.md) - Random decimal 0-1
+- [randomfloatupto](./randomfloatupto.md) - Random decimal up to max
+- [randomintegerbetween](./randomintegerbetween.md) - Random integer in range
+
+## Notes
+
+- Returns result as string
+- Uses the DataGeneration service
+- Includes decimal precision

package/user-documentation/solverfunctions/randomfloatupto.md

@@ -0,0 +1,65 @@
+# randomfloatupto
+
+Generates a random floating-point number from 0 up to a maximum value.
+
+## Syntax
+
+```
+randomfloatupto(max)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `max` | Number | Maximum value |
+
+## Returns
+
+String - A random floating-point number from 0 to max.
+
+## Description
+
+The `randomfloatupto` function generates a random decimal number starting from 0 up to the specified maximum value.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = RANDOMFLOATUPTO(100.0)
+// Result: "47.832" (random between 0 and 100)
+```
+
+### Random Percentage
+
+```expression
+RandomPercent = RANDOMFLOATUPTO(100)
+// Random percentage with decimals
+```
+
+### Random Duration
+
+```expression
+RandomSeconds = RANDOMFLOATUPTO(60)
+// Random duration up to 1 minute
+```
+
+## Use Cases
+
+- **Scaling**: Random values up to a limit
+- **Percentages**: Random percent with decimals
+- **Time**: Random durations
+- **Testing**: Bounded decimal test data
+
+## Related Functions
+
+- [randomfloat](./randomfloat.md) - Random decimal 0-1
+- [randomfloatbetween](./randomfloatbetween.md) - Random decimal in range
+- [randomintegerupto](./randomintegerupto.md) - Random integer up to max
+
+## Notes
+
+- Starts from 0
+- Returns result as string
+- Uses the DataGeneration service

package/user-documentation/solverfunctions/randominteger.md

@@ -0,0 +1,56 @@
+# randominteger
+
+Generates a random integer.
+
+## Syntax
+
+```
+randominteger()
+```
+
+## Parameters
+
+None
+
+## Returns
+
+String - A random integer value.
+
+## Description
+
+The `randominteger` function generates a random integer. This is useful for creating random test data, unique identifiers, or implementing random selection.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = RANDOMINTEGER()
+// Result: "7342985621" (random each time)
+```
+
+### Random Selection
+
+```expression
+// Generate random index for array selection
+Index = RANDOMINTEGER() % ArrayLength
+```
+
+## Use Cases
+
+- **Test data**: Generate random values
+- **Randomization**: Random selection
+- **IDs**: Generate identifiers
+- **Games**: Random number generation
+
+## Related Functions
+
+- [randomintegerbetween](./randomintegerbetween.md) - Random integer in range
+- [randomintegerupto](./randomintegerupto.md) - Random integer up to max
+- [randomfloat](./randomfloat.md) - Random decimal number
+
+## Notes
+
+- Returns result as string
+- Uses the DataGeneration service
+- Each call produces different result

package/user-documentation/solverfunctions/randomintegerbetween.md

@@ -0,0 +1,72 @@
+# randomintegerbetween
+
+Generates a random integer between two values (inclusive).
+
+## Syntax
+
+```
+randomintegerbetween(min, max)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `min` | Number | Minimum value (inclusive) |
+| `max` | Number | Maximum value (inclusive) |
+
+## Returns
+
+String - A random integer between min and max.
+
+## Description
+
+The `randomintegerbetween` function generates a random integer within a specified range, including both the minimum and maximum values.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = RANDOMINTEGERBETWEEN(1, 10)
+// Result: "7" (random between 1 and 10)
+```
+
+### Dice Roll
+
+```expression
+DiceRoll = RANDOMINTEGERBETWEEN(1, 6)
+// Result: "4" (simulates rolling a die)
+```
+
+### Random Selection Index
+
+```expression
+// Select random item from list of 5 items
+Index = RANDOMINTEGERBETWEEN(0, 4)
+```
+
+### Random Age in Range
+
+```expression
+RandomAge = RANDOMINTEGERBETWEEN(18, 65)
+```
+
+## Use Cases
+
+- **Games**: Dice rolls, card draws
+- **Testing**: Generate bounded random values
+- **Sampling**: Random selection from range
+- **Simulation**: Random parameters
+
+## Related Functions
+
+- [randominteger](./randominteger.md) - Unbounded random integer
+- [randomintegerupto](./randomintegerupto.md) - Random integer from 0 to max
+- [randomfloatbetween](./randomfloatbetween.md) - Random decimal in range
+
+## Notes
+
+- Both min and max are inclusive
+- Returns result as string
+- Uses the DataGeneration service

package/user-documentation/solverfunctions/randomintegerupto.md

@@ -0,0 +1,64 @@
+# randomintegerupto
+
+Generates a random integer from 0 up to a maximum value.
+
+## Syntax
+
+```
+randomintegerupto(max)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `max` | Number | Maximum value (exclusive or inclusive based on implementation) |
+
+## Returns
+
+String - A random integer from 0 to max.
+
+## Description
+
+The `randomintegerupto` function generates a random integer starting from 0 up to the specified maximum value. This is useful for array indexing and random selection from lists.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = RANDOMINTEGERUPTO(100)
+// Result: "42" (random between 0 and 100)
+```
+
+### Array Index Selection
+
+```expression
+// Select random index for 10-element array
+Index = RANDOMINTEGERUPTO(10)
+```
+
+### Percentage Simulation
+
+```expression
+RandomPercent = RANDOMINTEGERUPTO(100)
+```
+
+## Use Cases
+
+- **Array indexing**: Random element selection
+- **Percentages**: Random percentage values
+- **Simulation**: Random values from zero
+- **Testing**: Generate test indices
+
+## Related Functions
+
+- [randominteger](./randominteger.md) - Unbounded random integer
+- [randomintegerbetween](./randomintegerbetween.md) - Random integer in range
+- [randomfloatupto](./randomfloatupto.md) - Random decimal up to max
+
+## Notes
+
+- Starts from 0
+- Returns result as string
+- Uses the DataGeneration service

package/user-documentation/solverfunctions/refreshtabularsection.md

@@ -0,0 +1,57 @@
+# refreshtabularsection
+
+Forces a tabular section to re-render its display.
+
+## Syntax
+
+```
+refreshtabularsection(sectionHash, groupHash)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `sectionHash` | String | The hash identifier of the section containing the tabular group |
+| `groupHash` | String | The hash identifier of the tabular group |
+
+## Returns
+
+Void. This function does not return a value.
+
+## Description
+
+The `refreshtabularsection` function forces a tabular form group to re-render its display. This is useful after programmatically modifying the underlying data of a tabular section, such as changing row counts, updating cell values, or restructuring the data. The re-render ensures that the displayed table reflects the current state of the data.
+
+## Examples
+
+### Refreshing after data modification
+
+```expression
+refreshtabularsection("DataSection", "DataGroup")
+// Forces the DataGroup table in DataSection to re-render
+```
+
+### Refreshing after row count change
+
+```expression
+settabularrowlength("Orders", "LineItems", 5)
+refreshtabularsection("Orders", "LineItems")
+// Sets row count then refreshes the display
+```
+
+## Use Cases
+
+- **Post-update refresh**: Re-render a table after programmatically modifying its data
+- **Data synchronization**: Ensure the display matches the current application state after bulk changes
+- **Layout correction**: Force a re-render to correct any display inconsistencies
+
+## Related Functions
+
+- [settabularrowlength](./settabularrowlength.md) - Sets the number of rows in a tabular data group
+
+## Notes
+
+- The section and group hashes must match hashes defined in the form configuration
+- This function only affects the display; it does not modify the underlying data
+- Typically called after other functions that modify tabular data programmatically

package/user-documentation/solverfunctions/resolvehtmlentities.md

@@ -0,0 +1,64 @@
+# resolvehtmlentities
+
+Converts HTML entities to their corresponding characters.
+
+## Syntax
+
+```
+resolvehtmlentities(text)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `text` | String | Text containing HTML entities |
+
+## Returns
+
+String - Text with HTML entities decoded.
+
+## Description
+
+The `resolvehtmlentities` function converts HTML entities (like `&`, `<`, `>`) back to their original characters.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = RESOLVEHTMLENTITIES("Hello & World")
+// Result: "Hello & World"
+```
+
+### Multiple Entities
+
+```expression
+Result = RESOLVEHTMLENTITIES("<div>Content</div>")
+// Result: "<div>Content</div>"
+```
+
+### Special Characters
+
+```expression
+Result = RESOLVEHTMLENTITIES("Price: &pound;100 &copy; 2025")
+// Result: "Price: £100 © 2025"
+```
+
+## Use Cases
+
+- **Data cleaning**: Decode HTML-encoded data
+- **Display**: Show proper characters
+- **Import**: Process HTML data
+- **Text processing**: Normalize text
+
+## Related Functions
+
+- [concat](./concat.md) - Combine strings
+- [join](./join.md) - Join strings
+
+## Notes
+
+- Decodes common HTML entities
+- Handles numeric entities
+- Uses the DataFormat service

package/user-documentation/solverfunctions/round.md

@@ -0,0 +1,111 @@
+# round
+
+Rounds a number to a specified number of decimal places.
+
+## Syntax
+
+```
+round(value)
+round(value, decimalPlaces)
+round(value, decimalPlaces, roundingMethod)
+```
+
+## Parameters
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `value` | Number/String | required | The value to round |
+| `decimalPlaces` | Number | 0 | Number of decimal places |
+| `roundingMethod` | Number | 1 | Rounding method (0-3) |
+
+### Rounding Methods
+
+| Value | Method | Description |
+|-------|--------|-------------|
+| 0 | Round Down | Truncate toward zero |
+| 1 | Round Half Up | Round to nearest, ties away from zero (default) |
+| 2 | Round Half Even | Round to nearest, ties to even (banker's rounding) |
+| 3 | Round Up | Always round away from zero |
+
+## Returns
+
+String - The rounded value.
+
+## Description
+
+The `round` function rounds a number to a specified number of decimal places using arbitrary precision arithmetic. It supports multiple rounding methods for different use cases.
+
+## Examples
+
+### Basic Usage (No Decimal Places)
+
+```expression
+Result = round(3.7)
+// Result: "4"
+
+Result = round(3.2)
+// Result: "3"
+
+Result = round(3.5)
+// Result: "4" (rounds up by default)
+```
+
+### With Decimal Places
+
+```expression
+Result = round(3.14159, 2)
+// Result: "3.14"
+
+Result = round(3.14159, 4)
+// Result: "3.1416"
+
+// From unit tests:
+Area = ROUND(X * Y * Z, 2)
+// With X=5.867, Y=3.1, Z=75: Area = 1364.0775
+// Result: "1364.08"
+```
+
+### With Custom Rounding Method
+
+```expression
+// Round up (method 3)
+Result = ROUND(X * Y * Z, 3, 3)
+// With X=5.867, Y=3.5, Z=75.248923423
+// Result: "1545.2"
+```
+
+### Dynamic Decimal Places
+
+```expression
+// Decimal places can be computed
+MATH_DP = ROUND(1.2345, 5 - 2)
+// Result: "1.235"
+```
+
+### In Complex Expressions
+
+```expression
+EGS = ROUND(ROUND(0.0172834*2.71828182845905^(-0.0117685*Temp),5)*SQRT(ROUND(16.294-0.163*HR,1)/60),4)
+// With Temp=24, HR=20.5
+// Result: "0.0061"
+```
+
+## Use Cases
+
+- **Financial calculations**: Rounding currency values
+- **Display formatting**: Showing clean numeric values
+- **Precision control**: Limiting decimal places in results
+- **Statistical output**: Rounding means, percentages, etc.
+
+## Related Functions
+
+- [tofixed](./tofixed.md) - Format to fixed decimal places
+- [floor](./floor.md) - Round down
+- [ceil](./ceil.md) - Round up
+
+## Notes
+
+- Uses arbitrary precision arithmetic
+- Returns a string representation
+- When no decimal places specified, rounds to nearest integer
+- Be careful with rounding methods in financial applications (banker's rounding may be preferred)