InterpObject1D




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

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

Key TAGs | Excel Index | API Index


Creates an one dimensional interpolation object.



This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "Interp1D"



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


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



Parameter Description


  1. Key parameter

    Key Handle to be used for the new interpolation object.
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. XArray parameter

    X values.
  4. YArray parameter

    Y values.
  5. InterpMethod parameter

    Interpolation methodology to utilise. Possible values are : 'BackStep', (for a flat interpolation in the backwards direction), 'ForwardStep', (for a flat interpolation in the forwards direction), 'Linear', 'LogLinear' or 'Cubic' (for Cubic-Spline).


Extended information

Function Syntax

VB Syntax 


String CTUtils.InterpObject1D( _
String Key, _
Long Reload, _
Variant XArray, _
Variant YArray, _
InterpEnum InterpMethod)


Excel Spreadsheet Syntax 


=CT.INTERP.InterpObject1D(
Excel String Cell Key,
Excel Numeric Cell Reload,
XLRange XArray,
XLRange YArray,
Excel String Cell InterpMethod)


C++ Syntax 


static std::string InterpObject1D(
std::string Key,
long Reload,
CTRangeDataCPP XArray,
CTRangeDataCPP YArray,
InterpEnum InterpMethod);


DotNET Syntax 


System.String CTUtilsSA.InterpObject1D(
System.String Key,
System.Int32 Reload,
CTRangeData XArray,
CTRangeData YArray,
CTIEnums.InterpEnum InterpMethod);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
XArrayRangeFALSE
YArrayRangeFALSE
InterpMethodInterpEnumFALSE

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
KeyFALSEMyInterpObject1D
ReloadFALSE1
XArrayFALSEInterpObject1D_XArray_Range (creates a range object)
YArrayFALSEInterpObject1D_YArray_Range (creates a range object)
InterpMethodFALSELinear


Example range for parameter : XArray

Within Excel, a range such as this can be passed directly into the XArray parameter.


Data is stored within the second column (Vector of data)..

Example C# API usage for setting the range data for parameter : XArray 


CTQL.CTRangeData InterpObject1D_XArray;


double[] arrBInterpObject1D_XArray = {
0.0,
5.0,
10.0,
15.0,
20.0,
25.0,
30.0,
35.0,
40.0,
45.0  //  Array Data

};

CTQL.DoubleVector arrInterpObject1D_XArray =
new  CTQL.DoubleVector(arrBInterpObject1D_XArray);

// Second parameter determines whether the array is a column array (false) or a row array (true)
InterpObject1D_XArray = new  CTQL.CTRangeData(arrInterpObject1D_XArray, false);

Example range for parameter : YArray

Within Excel, a range such as this can be passed directly into the YArray parameter.


Data is stored within the second column (Vector of data)..

Example C# API usage for setting the range data for parameter : YArray 


CTQL.CTRangeData InterpObject1D_YArray;


double[] arrBInterpObject1D_YArray = {
0.02,
0.025,
0.03,
0.035,
0.04,
0.045,
0.05,
0.055,
0.06,
0.065  //  Array Data

};

CTQL.DoubleVector arrInterpObject1D_YArray =
new  CTQL.DoubleVector(arrBInterpObject1D_YArray);

// Second parameter determines whether the array is a column array (false) or a row array (true)
InterpObject1D_YArray = new  CTQL.CTRangeData(arrInterpObject1D_YArray, false);


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 InterpObject1D() 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.


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 InterpObject1D() function call


MyInterpObject1D_9.Interp1D.0

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