Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevin-lee/skala
Utilities for Scala
https://github.com/kevin-lee/skala
scala utility
Last synced: 3 months ago
JSON representation
Utilities for Scala
- Host: GitHub
- URL: https://github.com/kevin-lee/skala
- Owner: kevin-lee
- License: mit
- Created: 2015-03-22T13:53:31.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2020-08-09T06:05:14.000Z (over 4 years ago)
- Last Synced: 2024-04-14T04:43:28.572Z (9 months ago)
- Topics: scala, utility
- Language: Scala
- Size: 159 KB
- Stars: 8
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Skala
=====
[](https://semaphoreci.com/kevin-lee/skala)
[](https://semaphoreci.com/kevin-lee/skala)
[](https://bintray.com/kevinlee/maven/skala/_latestVersion)
[](https://www.codacy.com/app/kevin-lee/skala?utm_source=github.com&utm_medium=referral&utm_content=Kevin-Lee/skala&utm_campaign=Badge_Grade)
[](https://coveralls.io/r/Kevin-Lee/skala)
[](https://travis-ci.org/Kevin-Lee/skala)
Utilities for Scala
## skala.math
### skala.math.BigInts
#### sqrt()
The square root of a BigInt value
```scala
import io.kevinlee.skala.math.BigInts._
sqrt(BigInt(9))
// Result: BigDecimal(3)
sqrt(BigInt(10))
// Result: BigDecimal(3.162277660168379331998893544432718)
sqrt(BigInt(-1))
// Result: IllegalArgumentException
```
#### findSqrt()
It returns `Option` may or may not have a square root of a `BigInt` value. This method doesn't throw any exception when a negative number is passed as a parameter. Instead, it returns `None`.
```scala
import io.kevinlee.skala.math.BigInts._
findSqrt(BigInt(9))
// Result: Some(BigDecimal(3))
findSqrt(BigInt(10))
// Result: Some(BigDecimal(3.162277660168379331998893544432718))
findSqrt(BigInt(-1))
// Result: None
```
#### mean()
It calculates a mean of `TraversableLike[BigInt, TraversableLike[BigInt, _]]`.
```scala
import io.kevinlee.skala.math.BigInts._
val numbers = List[BigInt](1, 2, 3)
mean(numbers) // returns BigDecimal(2)
```
#### median()
It finds a median of `Seq[BigInt]`.
```scala
import io.kevinlee.skala.math.BigInts._
val numbers = List[BigInt](1, 2, 3, 4)
median(numbers) // return BigDecimal(2.5)
```
```scala
import io.kevinlee.skala.math.BigInts._
val numbers = List[BigInt](2, 4, 3, 1)
median(numbers) // return BigDecimal(2.5)
```
```scala
import io.kevinlee.skala.math.BigInts._
val numbers = List[BigInt](1, 2, 3, 4, 5)
median(numbers) // return BigDecimal(3)
```
```scala
import io.kevinlee.skala.math.BigInts._
val numbers = List[BigInt](2, 3, 5, 4, 1)
median(numbers) // return BigDecimal(3)
```
### skala.math.BigDecimals
### sqrt()
The square root of a BigDecimal value
```scala
import io.kevinlee.skala.math.BigDecimals._
sqrt(BigDecimal(9))
// Result: BigDecimal(3)
sqrt(BigDecimal(10))
// Result: BigDecimal(3.162277660168379331998893544432718)
sqrt(BigDecimal(-1))
// Result: IllegalArgumentException
```
#### findSqrt()
It returns `Option` may or may not have a square root of a `BigDecimal` value. This method doesn't throw any exception when a negative number is passed as a parameter. Instead, it returns `None`.
```scala
import io.kevinlee.skala.math.BigDecimals._
findSqrt(BigDecimal(9))
// Result: Some(BigDecimal(3))
findSqrt(BigDecimal(10))
// Result: Some(BigDecimal(3.162277660168379331998893544432718))
findSqrt(BigDecimal(-1))
// Result: None
```
#### mean()
It calculates a mean of `TraversableLike[BigDecimal, TraversableLike[BigDecimal, _]]`.
```scala
import io.kevinlee.skala.math.BigDecimals._
val numbers = List[BigDecimal](1, 2, 3)
mean(numbers) // returns BigDecimal(2)
```
#### median()
It finds a median of `Seq[BigDecimal]`.
```scala
import io.kevinlee.skala.math.BigDecimals._
val numbers = List[BigDecimal](1, 2, 3, 4)
median(numbers) // return BigDecimal(2.5)
```
```scala
import io.kevinlee.skala.math.BigDecimals._
val numbers = List[BigDecimal](2, 4, 3, 1)
median(numbers) // return BigDecimal(2.5)
```
```scala
import io.kevinlee.skala.math.BigDecimals._
val numbers = List[BigDecimal](1, 2, 3, 4, 5)
median(numbers) // return BigDecimal(3)
```
```scala
import io.kevinlee.skala.math.BigDecimals._
val numbers = List[BigDecimal](2, 3, 5, 4, 1)
median(numbers) // return BigDecimal(3)
```
## Try with Resource
### tryWith
```scala
import io.kevinlee.skala.util.SideEffect.tryWith
```
```scala
tryWith(AutoCloseable) { autoCloseable =>
// run block
}
```
**`tryWith` is similar to Java's Try with Resource so it may throw an exception if the block or `AutoCloseable` throws any exception.**
```scala
val result: WhatEverTheRunBlockReturns = tryWith(AutoCloseable) { autoCloseable =>
// run block
}
```
```scala
tryWith(new FileInputStream("/path/to/file.txt")) { inputStream =>
var c = inputStream.read()
while (c != -1) {
print(c.asInstanceOf[Char])
c = inputStream.read()
}
}
```
```scala
tryWith(new FileInputStream("/path/to/file.txt")) { inputStream =>
tryWith(new InputStreamReader(inputStream)) { reader =>
var c = reader.read()
while (c != -1) {
print(c.asInstanceOf[Char])
c = reader.read()
}
}
}
```
```scala
val result = tryWith(new SomeResource()) { someSource =>
someSource.get
}
```
# Get Skala
In your `build.sbt`, add the following repo and dependency.
**Note: It supports Scala 2.11 and 2.12.**
```scala
resolvers += "3rd Party Repo" at "http://dl.bintray.com/kevinlee/maven"
libraryDependencies += "io.kevinlee" %% "skala" % "0.2.0"
```