add some comments and rename computeChartMaxValue util file name, bump version

Author: ehsannarmani

compose-charts/build.gradle.kts

@@ -15,7 +15,7 @@ mavenPublishing{
     coordinates(
         groupId = "io.github.ehsannarmani",
         artifactId = "compose-charts",
-        version = "0.1.9"
+        version = "0.1.10"
     )
     pom{
         name.set("Compose Charts")

compose-charts/src/commonMain/kotlin/ir/ehsannarmani/compose_charts/ColumnChart.kt

@@ -51,7 +51,6 @@ import ir.ehsannarmani.compose_charts.models.Bars
 import ir.ehsannarmani.compose_charts.models.DividerProperties
 import ir.ehsannarmani.compose_charts.models.GridProperties
 import ir.ehsannarmani.compose_charts.models.HorizontalIndicatorProperties
-import ir.ehsannarmani.compose_charts.models.IndicatorCount
 import ir.ehsannarmani.compose_charts.models.IndicatorPosition
 import ir.ehsannarmani.compose_charts.models.LabelHelperProperties
 import ir.ehsannarmani.compose_charts.models.LabelProperties
@@ -63,7 +62,7 @@ import ir.ehsannarmani.compose_charts.utils.ImplementRCAnimation
 import ir.ehsannarmani.compose_charts.utils.calculateOffset
 import ir.ehsannarmani.compose_charts.utils.checkRCMaxValue
 import ir.ehsannarmani.compose_charts.utils.checkRCMinValue
-import ir.ehsannarmani.compose_charts.utils.rememberComputedMaxValue
+import ir.ehsannarmani.compose_charts.utils.rememberComputedChartMaxValue
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
 import kotlin.math.absoluteValue
@@ -130,7 +129,7 @@ fun ColumnChart(
         Animatable(0f)
     }
 
-    val computedMaxValue = rememberComputedMaxValue(minValue, maxValue, indicatorProperties.count)
+    val computedMaxValue = rememberComputedChartMaxValue(minValue, maxValue, indicatorProperties.count)
     val indicators = remember(minValue, computedMaxValue) {
         indicatorProperties.indicators.ifEmpty {
             split(

compose-charts/src/commonMain/kotlin/ir/ehsannarmani/compose_charts/LineChart.kt

@@ -71,7 +71,7 @@ import ir.ehsannarmani.compose_charts.models.PopupProperties
 import ir.ehsannarmani.compose_charts.models.ZeroLineProperties
 import ir.ehsannarmani.compose_charts.utils.HorizontalLabels
 import ir.ehsannarmani.compose_charts.utils.calculateOffset
-import ir.ehsannarmani.compose_charts.utils.rememberComputedMaxValue
+import ir.ehsannarmani.compose_charts.utils.rememberComputedChartMaxValue
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.delay
@@ -155,7 +155,7 @@ fun LineChart(
         mutableStateListOf<PathData>()
     }
 
-    val computedMaxValue = rememberComputedMaxValue(minValue, maxValue, indicatorProperties.count)
+    val computedMaxValue = rememberComputedChartMaxValue(minValue, maxValue, indicatorProperties.count)
     val indicators = remember(indicatorProperties.indicators, minValue, maxValue) {
         indicatorProperties.indicators.ifEmpty {
             split(

compose-charts/src/commonMain/kotlin/ir/ehsannarmani/compose_charts/RowChart.kt

@@ -55,7 +55,6 @@ import ir.ehsannarmani.compose_charts.models.GridProperties
 import ir.ehsannarmani.compose_charts.models.IndicatorPosition
 import ir.ehsannarmani.compose_charts.models.LabelHelperProperties
 import ir.ehsannarmani.compose_charts.models.LabelProperties
-import ir.ehsannarmani.compose_charts.models.Line
 import ir.ehsannarmani.compose_charts.models.PopupProperties
 import ir.ehsannarmani.compose_charts.models.SelectedBar
 import ir.ehsannarmani.compose_charts.models.VerticalIndicatorProperties
@@ -65,7 +64,7 @@ import ir.ehsannarmani.compose_charts.utils.VerticalLabels
 import ir.ehsannarmani.compose_charts.utils.calculateOffset
 import ir.ehsannarmani.compose_charts.utils.checkRCMaxValue
 import ir.ehsannarmani.compose_charts.utils.checkRCMinValue
-import ir.ehsannarmani.compose_charts.utils.rememberComputedMaxValue
+import ir.ehsannarmani.compose_charts.utils.rememberComputedChartMaxValue
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
 import kotlin.math.absoluteValue
@@ -132,7 +131,7 @@ fun RowChart(
         Animatable(0f)
     }
 
-    val computedMaxValue = rememberComputedMaxValue(minValue, maxValue, indicatorProperties.count)
+    val computedMaxValue = rememberComputedChartMaxValue(minValue, maxValue, indicatorProperties.count)
     val indicators = remember(minValue, computedMaxValue) {
         indicatorProperties.indicators.ifEmpty {
             split(

compose-charts/src/commonMain/kotlin/ir/ehsannarmani/compose_charts/utils/IndicatorValues.kt

@@ -0,0 +1,36 @@
+package ir.ehsannarmani.compose_charts.utils
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+import ir.ehsannarmani.compose_charts.models.IndicatorCount
+
+@Composable
+fun rememberComputedChartMaxValue(minValue: Double, maxValue: Double, count: IndicatorCount) : Double {
+    return remember(minValue, maxValue, count) {
+        computeChartMaxValue(minValue, maxValue, count)
+    }
+}
+
+internal fun computeChartMaxValue(minValue: Double, maxValue: Double, count: IndicatorCount): Double {
+    return when (count) {
+        is IndicatorCount.CountBased -> maxValue
+        is IndicatorCount.StepBased -> {
+            /**
+             * Why we are doing this?
+             * if maxValue-minValue not dividable for `stepBy` (grater than zero remainder),
+             * the generated numbers for indicators will have inconsistency
+             * for example: (minValue=0,maxValue=5,stepBy=2) the generated indicator numbers will be: (5,3,1,0)
+             * we will have inconsistency between 0 and 1 compared to other numbers, so indicators will show incorrect data in the end
+             * so we check, if maxValue-minValue is not dividable for stepBy, we add the remainder to maxValue to avoid this issue
+             */
+            val span = maxValue - minValue
+            val remainder = span % count.stepBy
+
+            if (remainder == 0.0) {
+                maxValue
+            } else {
+                maxValue + (count.stepBy - remainder)
+            }
+        }
+    }
+}