forked from kscience/kmath
Minor documentation update
This commit is contained in:
parent
ce5c281427
commit
8da54786a0
18
README.md
18
README.md
@ -6,15 +6,29 @@ and `scipy` it is modular and has a lightweight core.
|
|||||||
|
|
||||||
* **Algebra**
|
* **Algebra**
|
||||||
* Mathematical operation entities like rings, spaces and fields with (**TODO** add example to wiki)
|
* Mathematical operation entities like rings, spaces and fields with (**TODO** add example to wiki)
|
||||||
* Basic linear algebra operations (summs products, etc) backed by `Space` API.
|
* Basic linear algebra operations (sums products, etc) backed by `Space` API.
|
||||||
* [In progress] advanced linear algebra operations like matrix inversions.
|
* [In progress] advanced linear algebra operations like matrix inversions.
|
||||||
* **Array-like structures** Full support of numpy-like ndarray including mixed ariphmetic operations and function operations
|
* **Array-like structures** Full support of numpy-like ndarray including mixed arithmetic operations and function operations
|
||||||
on arrays and numbers just like it works in python (with benefit of static type checking).
|
on arrays and numbers just like it works in python (with benefit of static type checking).
|
||||||
|
|
||||||
|
## Planned features
|
||||||
|
|
||||||
|
* **Common mathematics** It is planned to gradually wrap most parts of [Apache commons-math](http://commons.apache.org/proper/commons-math/)
|
||||||
|
library in kotlin code and maybe rewrite some parts to better suite kotlin programming paradigm. There is no fixed priority list for that. Feel free
|
||||||
|
to submit a future request if you want something to be done first.
|
||||||
|
|
||||||
|
* **Expressions** Expressions are one of the ultimate goals of kmath. It is planned to be able to write some mathematical
|
||||||
|
expression once an then apply it to different types of objects by providing different context. Exception could be used
|
||||||
|
for a wide variety of purposes from high performance calculations to code generation.
|
||||||
|
|
||||||
|
* **Messaging** A mathematical notation to support multilanguage and multinod communication for mathematical tasks.
|
||||||
|
|
||||||
## Multi-platform support
|
## Multi-platform support
|
||||||
KMath is developed as a multi-platform library, which means that most of interfaces are declared in common module.
|
KMath is developed as a multi-platform library, which means that most of interfaces are declared in common module.
|
||||||
Implementation is also done in common module wherever it is possible. In some cases features are delegated to
|
Implementation is also done in common module wherever it is possible. In some cases features are delegated to
|
||||||
platform even if they could be done in common module because of platform performance optimization.
|
platform even if they could be done in common module because of platform performance optimization.
|
||||||
|
Currently the main focus of development is the JVM platform, contribution of implementations for Kotlin - Native and
|
||||||
|
Kotlin - JS is welcome.
|
||||||
|
|
||||||
## Performance
|
## Performance
|
||||||
The calculation performance is one of major goals of KMath in the future, but in some cases it is not possible to achieve
|
The calculation performance is one of major goals of KMath in the future, but in some cases it is not possible to achieve
|
||||||
|
@ -3,6 +3,8 @@ package scientifik.kmath.operations
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The generic mathematics elements which is able to store its context
|
* The generic mathematics elements which is able to store its context
|
||||||
|
* @param T the self type of the element
|
||||||
|
* @param S the type of mathematical context for this element
|
||||||
*/
|
*/
|
||||||
interface MathElement<T, S>{
|
interface MathElement<T, S>{
|
||||||
/**
|
/**
|
||||||
|
Loading…
Reference in New Issue
Block a user