InterpForValue2D




http://www.QuantTools.com
CapeTools Utils function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index


Given X and Y point values and a two dimensional interpolation object created via the InterpObject2D() function call, interpolates for the Z value.



Note: Within Excel, the function is named - CT.INTERP.InterpForValue2D


High level graphic of InterpForValue2D() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. InterpObject parameter

    2D Interpolation Object.
  2. XValue parameter

    X value to interpolate.
  3. YValue parameter

    Y value to interpolate.
  4. Extrapolate parameter

    Whether you wish to extrapolate for the Z value, if the X or Y value is not within the XArray or YArray range.


Extended information

Function Syntax

VB Syntax 


Double CTUtils.InterpForValue2D( _
String InterpObject, _
Double XValue, _
Double YValue, _
Boolean Extrapolate)


Excel Spreadsheet Syntax 


=CT.INTERP.InterpForValue2D(
Excel String Cell InterpObject,
Excel Numeric Cell XValue,
Excel Numeric Cell YValue,
Excel Boolean Value Cell Extrapolate)


C++ Syntax 


static double InterpForValue2D(
std::string InterpObject,
double XValue,
double YValue,
bool Extrapolate);


DotNET Syntax 


System.Double CTUtilsSA.InterpForValue2D(
System.String InterpObject,
System.Double XValue,
System.Double YValue,
System.Boolean Extrapolate);

Parameter data types

ArgNameArgTypeIsKey
InterpObjectStringTRUE
XValueDoubleFALSE
YValueDoubleFALSE
ExtrapolateBooleanFALSE

Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
InterpObjectFALSEInterpObjectNAME.EXTTAG.TICKER (from a function call)
XValueFALSE6.5
YValueFALSE32.0
ExtrapolateFALSEtrue


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Utils20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the InterpForValue2D() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.

These are the financial QuantTools sub-function calls that are used within the examples :





The objects generated by these sub-functions are inter-connected in the following way :




The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the InterpForValue2D() function call


0.3

Copyright (c) 2003-2007 CapeTools - All Rights Reserved.