diff options
| author | Jakob Odersky <jodersky@gmail.com> | 2012-11-01 13:31:37 +0100 |
|---|---|---|
| committer | Jakob Odersky <jodersky@gmail.com> | 2012-11-01 13:31:37 +0100 |
| commit | 588583bee6f9758983dd3e6ebc4b278c85e3ab45 (patch) | |
| tree | d7865e54706758c9c43165979e495a2e62fe0c31 | |
| parent | 8a5080df8b1763b29e26152b8eac882908236077 (diff) | |
| download | scalam-588583bee6f9758983dd3e6ebc4b278c85e3ab45.tar.gz scalam-588583bee6f9758983dd3e6ebc4b278c85e3ab45.tar.bz2 scalam-588583bee6f9758983dd3e6ebc4b278c85e3ab45.zip | |
documentation
| -rw-r--r-- | src/main/scala/scalam/m/ast/Identifier.scala | 2 | ||||
| -rw-r--r-- | src/main/scala/scalam/math/package.scala | 4 |
2 files changed, 4 insertions, 2 deletions
diff --git a/src/main/scala/scalam/m/ast/Identifier.scala b/src/main/scala/scalam/m/ast/Identifier.scala index 45dd967..013f641 100644 --- a/src/main/scala/scalam/m/ast/Identifier.scala +++ b/src/main/scala/scalam/m/ast/Identifier.scala @@ -2,7 +2,7 @@ package scalam.m.ast /** * A matlab identifier. - * @name name of variable (this must be a valid matlab identifier string) + * @param name name of variable (this must be a valid matlab identifier string) * * @define construct identifier */ diff --git a/src/main/scala/scalam/math/package.scala b/src/main/scala/scalam/math/package.scala index 44e6876..44d324f 100644 --- a/src/main/scala/scalam/math/package.scala +++ b/src/main/scala/scalam/math/package.scala @@ -10,11 +10,13 @@ package object math { * The algorithm takes a window of width `width` that "slides" along the whole collection. * A new collection is created by taking the average of all points located in each window. * + * @usecase def smooth[Elem, Coll[Elem]](collection: Coll[Elem], width: Int, passes: Int): Coll[Elem] = sys.error("") + * * @param collection the collection to smooth * @param width the window's witdh * @param passes how many times the collection is smoothed (i.e. how often smooth calls itself recursively) * @tparam Elem the type of the elements contained in the collection - * @tparam Coll[Elem] the type of the collection to be smoothed + * @tparam Coll the type of the collection to be smoothed */ def smooth[Elem, Coll[Elem]](collection: Coll[Elem], width: Int, passes: Int = 1)(implicit fractional: Fractional[Elem], cbf: CanBuildFrom[Coll[Elem], Elem, Coll[Elem]], view: Coll[Elem] => Seq[Elem]): Coll[Elem] = { def average(xs: Seq[Elem]): Elem = { |