de.sciss.fscape.graph.Pearson.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fscape-core_2.11 Show documentation

An audio rendering library

The newest version!

/*
 *  Pearson.scala
 *  (FScape)
 *
 *  Copyright (c) 2001-2016 Hanns Holger Rutz. All rights reserved.
 *
 *  This software is published under the GNU General Public License v2+
 *
 *
 *  For further information, please contact Hanns Holger Rutz at
 *  [email protected]
 */

package de.sciss.fscape
package graph

import de.sciss.fscape.stream.{StreamIn, StreamOut}

import scala.collection.immutable.{IndexedSeq => Vec}

/** A UGen that calculates the Pearson product-moment correlation coefficient of
  * two input matrices.
  *
  * @param x      first matrix
  * @param y      second matrix
  * @param size   matrix or window size
  */
final case class Pearson(x: GE, y: GE, size: GE) extends UGenSource.SingleOut {
  protected def makeUGens(implicit b: UGenGraph.Builder): UGenInLike =
    unwrap(Vector(x.expand, y.expand, size.expand))

  protected def makeUGen(args: Vec[UGenIn])(implicit b: UGenGraph.Builder): UGenInLike =
    UGen.SingleOut(this, args)

  private[fscape] def makeStream(args: Vec[StreamIn])(implicit b: stream.Builder): StreamOut = {
    val Vec(x, y, size) = args
    stream.Pearson(x = x.toDouble, y = y.toDouble, size = size.toInt)
  }
}