readme

Author: dc0d32

Kneedle.sln

@@ -3,9 +3,14 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.28307.168
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kneedle", "Kneedle\Kneedle.csproj", "{F17D3B14-C2FB-4631-8625-BEA3E2E23396}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Kneedle", "Kneedle\Kneedle.csproj", "{F17D3B14-C2FB-4631-8625-BEA3E2E23396}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kneedle.Tests", "Kneedle.Tests\Kneedle.Tests.csproj", "{B06F925D-6AAD-4D1C-84A4-FFB1EB96EC2A}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Kneedle.Tests", "Kneedle.Tests\Kneedle.Tests.csproj", "{B06F925D-6AAD-4D1C-84A4-FFB1EB96EC2A}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{887604A3-1010-45DC-9F59-E3883795F4AE}"
+	ProjectSection(SolutionItems) = preProject
+		README.md = README.md
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

README.md

@@ -1,2 +1,25 @@
 # Kneedle
-Implementation of knee/elbow finding algorithm 'Kneedle' in c#
+Implementation of knee/elbow finding algorithm 'Kneedle' in c#.
+
+Calculates knee points using the Kneedle algorithm. Returns the x value corresponding to the knee point when successful, null otherwise.
+
+## Reference
+    "Finding a ‘kneedle’ in a haystack: Detecting knee points in system behavior. "
+    Satopaa, V and Albrecht, J and Irwin, D and Raghavan, B
+    31-st International Conference on Distributed Computing Systems
+    2011
+[https://raghavan.usc.edu/papers/kneedle-simplex11.pdf]
+
+
+## Inputs
+Needs the data points provided x-sorted.
+
+Positive curvature is when the tangent traces anti-clockwise.
+
+## Output
+Returns the x value corresponding to the knee point.
+
+Can return null when the algorithm fails to identify a knee/elbow for various reasons:
+- the number of data points is too small
+- there are no local maxima on the diffs, which means either the curve is a line, or the parameters provided are incompatible with the curve
+