ddf.minim.ugens

Class Reciprocal

java.lang.Object

ddf.minim.UGen

ddf.minim.ugens.Reciprocal

public class Reciprocal
extends UGen

A UGen which simply returns the reciprocal value of it's input. Because this UGen is intended for use with control signals, rather than audio signals, it behaves as a mono UGen, regardless of whether or not it has been configured with more than one channel. This means that the output of Reciprocal will always be the reciprocal of the first (and usually only) channel of the denominator input copied to all output channels, similar to Constant.

Author:

nodog

Nested Class Summary

Nested classes/interfaces inherited from class ddf.minim.UGen

UGen.InputType, UGen.UGenInput

Field Summary

Fields

Modifier and Type	Field and Description
UGen.UGenInput	denominator denominator is the default audio input

Constructor Summary

Constructors

Constructor and Description
Reciprocal() Constructs a Reciprocal with a denominator of 1.
Reciprocal(float fixedDenominator) Constructs a Reciprocal with the given denominator value.

Method Summary

Modifier and Type	Method and Description
void	setReciprocal(float fixedDenominator) Used to change the fixedDenominator value after instantiation
protected void	uGenerate(float[] channels) Implement this method when you extend UGen.

Methods inherited from class ddf.minim.UGen

addAudio, addControl, addControl, addInput, channelCount, channelCountChanged, getLastValues, patch, patch, patch, printInputs, removeInput, sampleRate, sampleRateChanged, setChannelCount, setSampleRate, tick, unpatch, unpatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

denominator

public UGen.UGenInput denominator

denominator is the default audio input

Constructor Detail

Reciprocal

public Reciprocal()

Constructs a Reciprocal with a denominator of 1.

Reciprocal

public Reciprocal(float fixedDenominator)

Constructs a Reciprocal with the given denominator value.

Parameters:

fixedDenominator - the denominator value if the input is never connected

Method Detail

setReciprocal

public void setReciprocal(float fixedDenominator)

Used to change the fixedDenominator value after instantiation

Parameters:

fixedDenominator - the denominator value if the input is never connected

uGenerate

protected void uGenerate(float[] channels)

Description copied from class: UGen

Implement this method when you extend UGen. It will be called when your UGen needs to generate one sample frame of audio. It is expected that you will assign values to the array and not simply modify the existing values. In the case where you write a UGen that takes audio input and modifies it, the pattern to follow is to have the first UGenInput you create be your audio input and then in uGenerate you will use the getLastValues method of your audio UGenInput to retrieve the audio you want to modify, which you will then modify however you need to, assigning the result to the values in channels.

Specified by:

uGenerate in class UGen

Parameters:

channels - an array representing one sample frame.