PoleResidue

java.lang.Object

org.drip.function.definition.PoleResidue

public class PoleResidue
extends java.lang.Object

PoleResidue holds the Residue for given variate, if it is a Pole.

Module = Computational Core Module
Library = Numerical Analysis Library
Project = R^d To R^d Function Analysis
Package = Function Implementation Ancillary Support Objects

Author:: Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor Description

PoleResidue(double variate, double residue)
PoleResidue Constructor

Method Summary

Modifier and Type	Method	Description
`boolean`	`isPole()`	Indicate if the Variate is a Pole
`boolean`	`isPoleSimple()`	Indicate if the Variate is a Simple Pole
`static PoleResidue`	`NotAPole(double variate)`	Construct a "Not-A-Pole" Version of PoleResidue
`double`	`residue()`	Retrieve the Residue
`double`	`variate()`	Retrieve the Variate

Methods inherited from class java.lang.Object

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

Constructor Details
- PoleResidue
  
  public PoleResidue(double variate, double residue) throws java.lang.Exception
  
  PoleResidue Constructor
  
  Parameters:
  
  variate - The Variate
  
  residue - The Residue
  
  Throws:
  
  java.lang.Exception - Thrown if the Inputs are Invalid
Method Details
- NotAPole
  
  public static final PoleResidue NotAPole(double variate)
  
  Construct a "Not-A-Pole" Version of PoleResidue
  
  Parameters:
  
  variate - The Variate
  
  Returns:
  
  "Not-A-Pole" Version of PoleResidue
- variate
  
  public double variate()
  
  Retrieve the Variate
  
  Returns:
  
  The Variate
- residue
  
  public double residue()
  
  Retrieve the Residue
  
  Returns:
  
  The Residue
- isPole
  
  public boolean isPole()
  
  Indicate if the Variate is a Pole
  
  Returns:
  
  TRUE - The Variate is a Pole
- isPoleSimple
  
  public boolean isPoleSimple()
  
  Indicate if the Variate is a Simple Pole
  
  Returns:
  
  TRUE - The Variate is a Simple Pole