Section 3: library functions
Mat_VarReadInfo – Read the information for a specific variable in a MATLAB MAT file. Synopsis Fd #include <matio.h> Ft matvar_t * Fo Mat_VarReadInfo Fa mat_t *mat Fa const char *name Fc Description The Fn Mat_VarReadInfo function reads the information for the variable Fa name in the open MAT file. Return Values If the variable was…
Mat_VarRead – Reads the information and data for a specific variable in a MATLAB MAT file. Synopsis Fd #include <matio.h> Ft matvar_t * Fo Mat_VarRead Fa mat_t *mat Fa const char *name Fc Description The Fn Mat_VarRead function reads the information and data for the variable Fa name in the open MAT file. Return Values…
Mat_VarGetStructsLinear – Linearly index a structure variable Synopsis Fd #include <matio.h> Ft matvar_t * Fo Mat_VarGetStructsLinear Fa const matvar_t *matvar Fa int start Fa int stride Fa int edge Fa int copy_fields Fc Description The Fn Mat_VarGetStructsLinear function selects a subarray from a structure array Fa matvar. Each of the elements in the subarray contains…
Mat_VarGetStructs – Index a structure variable using slices of each dimension Synopsis Fd #include <matio.h> Ft matvar_t * Fo Mat_VarGetStructs Fa const matvar_t *matvar Fa int *start Fa int *stride Fa int *edge Fa int copy_fields Fc Description The Fn Mat_VarGetStructs function selects a subarray from a structure array Fa matvar. Each of the elements…
Mat_VarGetStructFieldnames – Get the fieldnames of a structure variable. Synopsis Fd #include <matio.h> Ft char * const * Fo Mat_VarGetStructFieldnames Fa const matvar_t *matvar Fc Description The Fn Mat_VarGetStructFieldnames function returns the fieldnames of the structure variable Fa matvar. Return Values An array of fieldnames is returned of the variable is a valid structure variable….
Mat_VarGetNumberOfFields – Get the number of fields for a structure variable. Synopsis Fd #include <matio.h> Ft unsigned Fo Mat_VarGetNumberOfFields Fa const matvar_t *matvar Fc Description The Fn Mat_VarGetNumberOfFields function returns the number of fields for the structure variable Fa matvar. Return Values The number of fields will be returned on success, and 0 otherwise. Note…
Mat_VarFree – Free a MAT variable structure Synopsis Fd #include <matio.h> Ft void Fo Mat_VarRead Fa matvar_t *matvar Fc Description The Fn Mat_VarFree function free’s the memory used by a MAT variable structure. If the variable was no created with the MAT_F_DONT_COPY_DATA flag, the variable data is also free’d. See Also Mat_VarCreate3, Mat_VarCreateStruct3
Mat_VarCreateStruct – Creates a structure variable. Synopsis Fd #include <matio.h> Ft matvar_t * Fo Mat_VarCreateStruct Fa const char *name Fa int rank Fa size_t *dims Fa const char **fields Fa unsigned nfields Fc Description The Fn Mat_VarCreateStruct function creates a structure variable named Fa name that can be written to a MAT file. Return Values…
Mat_VarCreate – Creates a MAT variable structure. Synopsis Fd #include <matio.h> Ft matvar_t * Fo Mat_VarCreate Fa const char *name Fa enum matio_classes class_type Fa enum matio_types data_type Fa int rank Fa size_t *dims Fa void *data Fa int opt Fc Description The Fn Mat_VarCreate function creates a MAT structure variable named Fa name that…
Mat_VarAddStructField – Add field to a structure array. Synopsis Fd #include <matio.h> Ft int Fo Mat_VarAddStructField Fa matvar_t *matvar Fa const char *fieldname Fc Description The Fn Mat_VarAddStructField function adds a fieldname to the structure variable Fa matvar. Return Values 0 is returned on success. See Also Mat_VarCreateStruct3
Mat_Rewind – Rewind an open .mat file to the beginning Synopsis Fd #include <matio.h> Ft int Fo Mat_Rewind Fa mat_t *matfp Fc Description Rewinds an open .mat file so that Mat_VarReadNext3 or Mat_VarReadNextInfo3 reads the first variable in the file. Return Values The function returns 0 on success, or -1 on failure. Examples The following…
Mat_Open – Open a MATLAB .mat file Synopsis Fd #include <matio.h> Ft mat_t Fo Mat_Open Fa const char *matname Fa int mode Fc Description The Fn Mat_Open function opens a MATLAB .mat file for read only or read-write access. Examples #include <stdlib.h> #include <stdio.h> #include "matio.h" int main(int argc,char **argv) { mat_t *matfp; matfp =…
Mat_GetVersion – Returns the filename of a MATLAB .mat file given a MAT file structure Synopsis Fd #include <matio.h> Ft enum mat_ft Fo Mat_GetVersion Fa mat_t *matfp Fc Description The Fn Mat_GetVersion function returns the version of the MATLAB .mat file given by the MAT file structure. The return value is one of the following:…
Mat_GetLibraryVersion – Get the version of the matio library Synopsis Fd #include <matio.h> Ft void Fo Mat_GetLibraryVersion Fa int *major Fa int *minor Fa int *release Fc Description The Fn Mat_GetLibraryVersion function returns the major, minor, and release version numbers of the library. These can be used to check that the version specified in the…
Mat_GetFilename – Returns the filename of a MATLAB .mat file given a MAT file structure Synopsis Fd #include <matio.h> Ft const char * Fo Mat_GetFilename Fa mat_t *matfp Fc Description The Fn Mat_GetFilename function returns the filename of the MATLAB .mat file given by the MAT file structure. See Also Mat_Create3, Mat_CreateVer3, Mat_Open3 Mat_GetVersion3
Mat_CreateVer Mat_Create – Create a MATLAB .mat file Synopsis Fd #include <matio.h> Ft mat_t * Fo Mat_CreateVer Fa const char *matname Fa const char *hdr_str Fa enum mat_ft mat_file_ver Fc Ft mat_t * Fo Mat_Create Fa const char *matname Fa const char *hdr_str Fc Description The Fn Mat_CreateVer function creates a MATLAB .mat file opened…
Mat_Close – Closes an open MATLAB .mat file Synopsis Fd #include <matio.h> Ft int Fo Mat_Close Fa mat_t *matname Fc Description The Fn Mat_Close function closes a MATLAB .mat file opened with Fn Mat_Open or created with Fn Mat_CreateVer Examples #include "matio.h" int main(int argc,char **argv) { mat_t *matfp; matfp = Mat_Open(argv[1],MAT_ACC_RDONLY); if ( NULL…
QuantLib::MarketModelPathwiseMultiDeflatedCap – Synopsis #include <ql/models/marketmodels/products/pathwise/pathwiseproductcaplet.hpp> Inherits QuantLib::MarketModelPathwiseMultiProduct. Public Member Functions MarketModelPathwiseMultiDeflatedCap (const std::vector< Time > &rateTimes, const std::vector< Real > &accruals, const std::vector< Time > &paymentTimes, Rate strike, const std::vector< std::pair< Size, Size > > &startsAndEnds) virtual std::vector< Size > suggestedNumeraires () const virtual const EvolutionDescription & evolution () const virtual std::vector< Time > possibleCashFlowTimes…
QuantLib::MarketModelPathwiseMultiCaplet – market-model pathwise caplet Synopsis #include <ql/models/marketmodels/products/pathwise/pathwiseproductcaplet.hpp> Inherits QuantLib::MarketModelPathwiseMultiProduct. Public Member Functions MarketModelPathwiseMultiCaplet (const std::vector< Time > &rateTimes, const std::vector< Real > &accruals, const std::vector< Time > &paymentTimes, const std::vector< Rate > &strikes) virtual std::vector< Size > suggestedNumeraires () const virtual const EvolutionDescription & evolution () const virtual std::vector< Time > possibleCashFlowTimes () const…
QuantLib::MarketModelPathwiseDiscounter – Synopsis #include <ql/models/marketmodels/pathwisediscounter.hpp> Public Member Functions MarketModelPathwiseDiscounter (Time paymentTime, const std::vector< Time > &rateTimes) void getFactors (const Matrix &LIBORRates, const Matrix &Discounts, Size currentStep, std::vector< Real > &factors) const Detailed Description this class returns the number of units of the discretely compounding money market account that 1 unit of cash at the payment…