Refactor documentation for various filters and indicators to enhance clarity and consistency

- Updated Bessel, Bilateral, Blma, Butter, Conv, Ema, Kama, LSMA, MAMA, MGDI, SSF, USF, ATR, ADL, and ADOSC documentation to use bullet points for key concepts and features.
- Added a new Qodana configuration file for code analysis.
- Removed coverage configuration from Quantower.Tests.csproj to streamline testing setup.
This commit is contained in:
Miha Kralj
2025-12-31 23:39:47 -08:00
parent 11f4ec2497
commit d493bfd42f
175 changed files with 11977 additions and 897 deletions
+13 -13
View File
@@ -12,12 +12,12 @@ WMAPE emerged from retail and supply chain forecasting where aggregate accuracy
WMAPE accumulates both absolute errors and actual values, then computes their ratio. This approach means larger actual values contribute proportionally more to the final metric, providing a volume-weighted view of accuracy.
### Properties
### Characteristics
- **Volume-weighted**: High-value items contribute more to the metric
- **Scale-independent**: Result is always a percentage
- **Non-negative**: WMAPE ≥ 0, with 0 indicating perfect prediction
- **Aggregate interpretation**: Represents total error as percentage of total actual
* **Volume-weighted**: High-value items contribute more to the metric
* **Scale-independent**: Result is always a percentage
* **Non-negative**: WMAPE ≥ 0, with 0 indicating perfect prediction
* **Aggregate interpretation**: Represents total error as percentage of total actual
## Mathematical Foundation
@@ -126,14 +126,14 @@ WMAPE gives less weight to the small-volume item with high percentage error.
## Edge Cases
- **Zero Actual Sum**: Returns 0 when total actual is zero (handled via substitution)
- **NaN Handling**: Uses last valid value substitution
- **Single Input**: Not supported (requires two series)
- **Period = 1**: Returns current weighted percentage error
- **All Zero Actuals**: Uses epsilon substitution
* **Zero Actual Sum**: Returns 0 when total actual is zero (handled via substitution)
* **NaN Handling**: Uses last valid value substitution
* **Single Input**: Not supported (requires two series)
* **Period = 1**: Returns current weighted percentage error
* **All Zero Actuals**: Uses epsilon substitution
## Related Indicators
- [MAPE](../mape/Mape.md) - Mean Absolute Percentage Error (unweighted)
- [MAE](../mae/Mae.md) - Mean Absolute Error (non-percentage)
- [SMAPE](../smape/Smape.md) - Symmetric MAPE
* [MAPE](../mape/Mape.md) - Mean Absolute Percentage Error (unweighted)
* [MAE](../mae/Mae.md) - Mean Absolute Error (non-percentage)
* [SMAPE](../smape/Smape.md) - Symmetric MAPE