Skip to content

Commit

Permalink
adds readme and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
nikdon committed Nov 11, 2015
1 parent 7a25998 commit 3ee6d43
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,33 @@ At the moment the simplest direct scheme is implemented. It allows to ensure a m
- Singular value decomposition
- Eigen value decomposition

## Getting ranola

If you're using SBT, add the following line to your build file:

```scala
resolvers += "jitpack" at "https://jitpack.io"

libraryDependencies += "com.github.nikdon" % "ranola" % "v0.1.0"

```

For Maven:

```maven
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
<dependency>
<groupId>com.github.nikdon</groupId>
<artifactId>ranola</artifactId>
<version>v0.1.0</version>
</dependency>
```

## Randomized schemes

1. Generic scheme ([§4.1][1]) is designed for solving the fixed-rank problem, where the target rank of the input matrix is specified in advance. This algorithm works well for matrices whose singular values exhibit some decay, but they may produce a poor basis when the input matrix has a flat singular spectrum or when the input matrix is very large.
Expand Down
2 changes: 0 additions & 2 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ scalaVersion := "2.11.7"

licenses += ("Apache-2.0", url("http://opensource.org/licenses/Apache-2.0"))

libraryDependencies += "org.spire-math" % "spire_2.11" % "0.10.1"

libraryDependencies ++= Seq(
"org.scalanlp" %% "breeze" % "0.11.2",
"org.scalanlp" %% "breeze-natives" % "0.11.2",
Expand Down

0 comments on commit 3ee6d43

Please sign in to comment.