Cleanup

Spreads · May 28, 2017 · 6a323c0 · 6a323c0
1 parent 0b5ebdf
commit 6a323c0
Show file tree

Hide file tree

Showing 37 changed files with 150 additions and 4,468 deletions.
diff --git a/LICENSE.Dependencies.txt b/LICENSE.Dependencies.txt
@@ -59,30 +59,12 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-
 ### Dapper
 
 https://github.com/StackExchange/dapper-dot-net/blob/master/License.txt
 http://www.apache.org/licenses/LICENSE-2.0
 
 
-### Deedle
-
-https://github.com/BlueMountainCapital/Deedle/blob/master/LICENSE.md
-
-Copyright (c) 2012, BlueMountain Capital Management LLC
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
 ### fast-member
 
 Copyright (c) 2017, Marc Gravell

diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ series, and one could argue that memory is cheap. However, L1/L2/L3 caches
 are still small, and saving 50% of memory allows to place two times
 more useful data in the caches and to avoid needless cache trashing.
 
-Spreads library is written in F# (core parts) and C# (tests, unsafe code, extensions). 
+Spreads library is written in C# and F# and targets .NET 4.5.1 and .NET Standard 1.6 versions. 
 .NET gives native performance when optimized for memory access patterns, which means
  no functional data structures and minimum allocations.
 Even though .NET is a managed platform with garbage collection, in a steady state Spreads
@@ -63,9 +63,7 @@ We haven't compared Spreads performance to performance of commercial systems yet
 However, the main benchmark while developing Spreads was modern CPUs capabilities,
 not any existing product. We tried to achieve mechanical sympathy, to avoid any wasteful
 operations and to get the most from modern processors. Therefore, unless the fastest commercial
-products use magic or quantum computers, Spreads must be in the same bracket. There are 
-many known optimizations that are waiting to be implemented, and we will move closer
-to bare metal performance ceiling in the next versions.
+products use magic or quantum computers, Spreads must be in the same bracket.
 
 
 ## Series manipulation and join
@@ -229,7 +227,7 @@ file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 
 ## Status and version
-Current status is pre-release until the version 1.0. We will use [semantic versioning](http://semver.org/).
+Current status is alpha and we are actively working on [1.0-beta release](https://github.com/Spreads/Spreads/milestone/1). We will use [semantic versioning](http://semver.org/) after 1.0 release.
 
 ## Links
 

diff --git a/Spreads.sln b/Spreads.sln
@@ -22,19 +22,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project", "project", "{BF60
 		src\Spreads.Collections\Spreads.Collections.2017.fsproj = src\Spreads.Collections\Spreads.Collections.2017.fsproj
 		nuget\Spreads.Unsafe.nuspec = nuget\Spreads.Unsafe.nuspec
 		nuget\Spreads.Utils.nuspec = nuget\Spreads.Utils.nuspec
-		TODO.md = TODO.md
-	EndProjectSection
-EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tools", "tools", "{83F16175-43B1-4C90-A1EE-8E351C33435D}"
-	ProjectSection(SolutionItems) = preProject
-		docs\tools\generate.fsx = docs\tools\generate.fsx
-		docs\tools\templates\template.cshtml = docs\tools\templates\template.cshtml
-	EndProjectSection
-EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{8E6D5255-776D-4B61-85F9-73C37AA1FB9A}"
-	ProjectSection(SolutionItems) = preProject
-		docs\content\index.fsx = docs\content\index.fsx
-		docs\content\tutorial.fsx = docs\content\tutorial.fsx
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{ED8079DD-2B06-4030-9F0F-DC548F98E1C4}"
@@ -58,8 +45,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Spreads.Collections.Tests",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TAQParse", "tests\Spreads.TAQParser\TAQParse.csproj", "{EF96ECF7-82EA-48B7-B33D-0BEA4DE58349}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tools", "tools", "{4C4D42AF-D25A-49F3-BE50-F025E8AD5D8C}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Spreads", "src\Spreads\Spreads.csproj", "{70445300-4409-447E-B1AC-10FA148B9DD0}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Spreads.Core", "src\Spreads.Core\Spreads.Core.csproj", "{68A4EE77-DDF3-4E83-89C4-4473322D8006}"
@@ -222,8 +207,6 @@ Global
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
-		{83F16175-43B1-4C90-A1EE-8E351C33435D} = {A6A6AF7D-D6E3-442D-9B1E-58CC91879BE1}
-		{8E6D5255-776D-4B61-85F9-73C37AA1FB9A} = {A6A6AF7D-D6E3-442D-9B1E-58CC91879BE1}
 		{E789C72A-5CFD-436B-8EF1-61AA2852A89F} = {ED8079DD-2B06-4030-9F0F-DC548F98E1C4}
 		{D371BD54-788A-4B9F-83A3-306E1AE62732} = {ED8079DD-2B06-4030-9F0F-DC548F98E1C4}
 		{D2A8AD2E-0450-4E23-8488-06F19DF7882D} = {ED8079DD-2B06-4030-9F0F-DC548F98E1C4}

diff --git a/TODO.md b/TODO.md
diff --git a/docs/Comments.md b/docs/Comments.md
@@ -0,0 +1,31 @@
+Comment prefix codes:
+
+* `NB` means pay attantion to some non-obvious logic
+* `NB!` means pay a lot of attention because this could be a source of potential ot fixed bugs
+* `TODO` (`priority`) means:
+    - no priority, just normal TODO, uncategorized: could be a source of bug, never spend time on (`low`, `very low`) while uncategorized issues exit (mark them low at least)
+    - `bug` - zero priority,
+    - `high` - first priority,
+    - `low` means could live with it until better times,
+    - `very low` is premature optimization or some puristic unimportant stuff
+    - `perf`/`performance` there are reasons to believe that performance could be improved significantly; treat it as `low` unless with `!`
+    - `ux` - user experience with API: signatures, comments, etc.
+* `TODO!` means same as `TODO (high)` + `NB!`
+
+Docs
+
+[ ] Write introduction without Rx, about series, declarative transofrmations, cursors, how to write new
+cursors with examples
+[ ] Add nice tables/charts with performance benchmarks, compared to Deedle, Streams, LINQ
+[ ] Move above prefixes to contributing section, add CLA
+
+Features
+
+* [ ] Features on par with Deedle/Ix/Linq/Streams, e.g. aggregate/resample, Panels must support what Frames do when it makes sense
+
+
+Tests
+
+* [ ] For corectness and performance, we must generate random sets and use some well-know correct method, e.g. LINQ or Deedle. Each test that utilizes series functionality
+ must be significantly faster than LINQ/Deedle, otherwise it makes no sense to use Spreads.
+* [ ] Benchmark suite that could keep history.
diff --git a/docs/content/Period.fsx b/docs/content/Period.fsx
diff --git a/docs/content/index.fsx b/docs/content/index.fsx
diff --git a/docs/content/tutorial.fsx b/docs/content/tutorial.fsx