ADMB Documentation  11.1.2192
 All Classes Files Functions Variables Typedefs Friends Defines
Functions
gdbprintlib.h File Reference

(// $Id: gdbprintlib.h 1214 2013-09-22 14:56:14Z cgrandin $)

Function prototypes for printing ADMB objects during GDB sessions. More...

#include <fvar.hpp>
#include <admodel.h>
#include <df1b2fun.h>

Go to the source code of this file.

Functions

void pad ()
 Do nothing, this will be included by ADMB lexical analyzer so that the library is usable from within GDB.
void pad (double v)
 Print a double precision number to the screen.
void pad (const adstring &v)
 Print an adstring to the screen.
void pad (const dvar3_array &v)
 Print a dvar3_array to the screen.
void pad (const dvar3_array &v, int i)
 Print a matrix slice of a dvar3_array to the screen.
void pad (const dvar3_array &v, int i, int j)
 Print a vector slice of a dvar3_array to the screen.
void pad (const dvar3_array &v, int i, int j, int k)
 Print a scalar of a dvar3_array to the screen.
void pad (const dvar4_array &v)
 Print a dvar4_array to the screen.
void pad (const dvar4_array &v, int i)
 Print a 3D slice of a dvar4_array to the screen.
void pad (const dvar4_array &v, int i, int j)
 Print a matrix slice of a dvar4_array to the screen.
void pad (const dvar4_array &v, int i, int j, int k)
 Print a vector slice of a dvar4_array to the screen.
void pad (const d4_array &v)
 Print a d4_array to the screen.
void pad (const d4_array &v, int i)
 Print a 3D slice of a d4_array to the screen.
void pad (const d4_array &v, int i, int j)
 Print a matrix slice of a d4_array to the screen.
void pad (const d4_array &v, int i, int j, int k)
 Print a vector slice of a d4_array to the screen.
void pad (const d3_array &v)
 Print a d3_array to the screen.
void pad (const d3_array &v, int i)
 Print a matrix slice of a d3_array to the screen.
void pad (const d3_array &v, int i, int j)
 Print a vector slice of a d3_array to the screen.
void pad (const d3_array &v, int i, int j, int k)
 Print a scalar of a d3_array to the screen.
void pad (const i3_array &v)
 Print a i3_array to the screen.
void pad (const i3_array &v, int i)
 Print a matrix slice of a i3_array to the screen.
void pad (const i3_array &v, int i, int j)
 Print a vector slice of a i3_array to the screen.
void pad (const i3_array &v, int i, int j, int k)
 Print a scalar of a i3_array to the screen.
void pad (const i4_array &v)
 Print a i4_array to the screen.
void pad (const i4_array &v, int i)
 Print a 3D slice of a i4_array to the screen.
void pad (const i4_array &v, int i, int j)
 Print a matrix slice of a i4_array to the screen.
void pad (const i4_array &v, int i, int j, int k)
 Print a matrix slice of a i4_array to the screen.
void pad (const i4_array &v, int i, int j, int k, int l)
 Print a scalar of a i4_array to the screen.
void pad (const dvar_vector &v)
 Print a dvar_vector to the screen.
void pad (const dvar_vector &v, int i)
 Print an element of a dvar_vector to the screen.
void pad (const prevariable &v)
 Print a prevariable to the screen.
void pad (const dvector &v)
 Print a dvector to the screen.
void pad (const ivector &v)
 Print an ivector to the screen.
void pad (const dvar_matrix &v)
 Print a dvar_matrix to the screen.
void pad (const dvar_matrix &v, int i)
 Print a vector slice of a dvar_matrix to the screen.
void pad (const dvar_matrix &v, int i, int j)
 Print a scalar of a dvar_matrix to the screen.
void pad (const dmatrix &v)
 Print a dmatrix to the screen.
void pad (const dfsdmat &v)
 Print a dfsdmat (a matrix) to the screen.
void pad (const imatrix &v)
 Print a imatrix to the screen.
void pad (const imatrix &v, int i)
 Print a vector slice of an imatrix to the screen.
void pad (const imatrix &v, int i, int j)
 Print a scalar of an imatrix to the screen.
void padp (const dmatrix &v, int i)
 Print a vector slice of a dmatrix to the screen, with 12 significant figures.
void padp (const dvar_matrix &v, int i)
 Print a vector slice of a dvar_matrix to the screen, with 12 significant figures.
void pads (const dvar_vector &v)
 Print a dvar_vector to the screen in scientific notation, with 5 significant figures.
void pads (const dvar_vector &v, int i)
 Print an element of a dvar_vector to the screen in scientific notation.
void padsum (const dvar_vector &v)
 Print the sum of a dvar_vector to the screen.
void padsum (const dvector &v)
 Print the sum of a dvector to the screen.
void padsum (const ivector &v)
 Print the sum of an ivector to the screen.
void padsum (const dvar_matrix &v)
 Print the sum of a dvar_matrix to the screen.
void padsum (const dmatrix &v)
 Print the sum of a dmatrix to the screen.
void padsum (const imatrix &v)
 Print the sum of an imatrix to the screen.

Detailed Description

Function prototypes for printing ADMB objects during GDB sessions.

Author:
Chris Grandin, Dave Fournier
Date:
6/18/2013

Definition in file gdbprintlib.h.


Function Documentation

void pad ( const dvar3_array v)

Print a dvar3_array to the screen.

Parameters:
vThe dvar3_array to print
Returns:
Nothing

Definition at line 58 of file gdbprintlib.cpp.

void pad ( const dvar3_array v,
int  i 
)

Print a matrix slice of a dvar3_array to the screen.

Parameters:
vThe dvar3_array to print
i1-based index of the matrix to print
Returns:
Nothing

Definition at line 69 of file gdbprintlib.cpp.

void pad ( const dvar3_array v,
int  i,
int  j 
)

Print a vector slice of a dvar3_array to the screen.

Parameters:
vThe dvar3_array to print
i1-based index of the matrix to slice from
j1-based index of the row of the matrix to print
Returns:
Nothing

Definition at line 81 of file gdbprintlib.cpp.

void pad ( const dvar3_array v,
int  i,
int  j,
int  k 
)

Print a scalar of a dvar3_array to the screen.

Parameters:
vThe dvar3_array to print
i1-based index of the matrix to slice from
j1-based index of the row of the matrix to print
k1-based index of the element of the vector to print
Returns:
Nothing

Definition at line 94 of file gdbprintlib.cpp.

void pad ( const dvar4_array v)

Print a dvar4_array to the screen.

Parameters:
vThe dvar4_array to print
Returns:
Nothing

Definition at line 104 of file gdbprintlib.cpp.

void pad ( const dvar4_array v,
int  i 
)

Print a 3D slice of a dvar4_array to the screen.

Parameters:
vThe dvar4_array to print
i1-based index of the 3D object to print
Returns:
Nothing

Definition at line 115 of file gdbprintlib.cpp.

void pad ( const dvar4_array v,
int  i,
int  j 
)

Print a matrix slice of a dvar4_array to the screen.

Parameters:
vThe dvar4_array to print
i1-based index of the 3D object to print
j1-based index of the matrix to print
Returns:
Nothing

Definition at line 127 of file gdbprintlib.cpp.

void pad ( const dvar4_array v,
int  i,
int  j,
int  k 
)

Print a vector slice of a dvar4_array to the screen.

Parameters:
vThe dvar4_array to print
i1-based index of the 3D object to print
j1-based index of the matrix to print
k1-based index of the vector to print
Returns:
Nothing

Definition at line 140 of file gdbprintlib.cpp.

void pad ( const d4_array v)

Print a d4_array to the screen.

Parameters:
vThe d4_array to print
Returns:
Nothing

Definition at line 150 of file gdbprintlib.cpp.

void pad ( const d4_array v,
int  i 
)

Print a 3D slice of a d4_array to the screen.

Parameters:
vThe d4_array to print
i1-based index of the 3D object to print
Returns:
Nothing

Definition at line 160 of file gdbprintlib.cpp.

void pad ( const d4_array v,
int  i,
int  j 
)

Print a matrix slice of a d4_array to the screen.

Parameters:
vThe d4_array to print
i1-based index of the 3D object to print
j1-based index of the matrix to print
Returns:
Nothing

Definition at line 172 of file gdbprintlib.cpp.

void pad ( const d4_array v,
int  i,
int  j,
int  k 
)

Print a vector slice of a d4_array to the screen.

Parameters:
vThe d4_array to print
i1-based index of the 3D object to print
j1-based index of the matrix to print
k1-based index of the vector to print
Returns:
Nothing

Definition at line 185 of file gdbprintlib.cpp.

void pad ( const d3_array v)

Print a d3_array to the screen.

Parameters:
vThe d3_array to print
Returns:
Nothing

Definition at line 195 of file gdbprintlib.cpp.

void pad ( const d3_array v,
int  i 
)

Print a matrix slice of a d3_array to the screen.

Parameters:
vThe d3_array to print
i1-based index of the matrix to print
Returns:
Nothing

Definition at line 206 of file gdbprintlib.cpp.

void pad ( const d3_array v,
int  i,
int  j 
)

Print a vector slice of a d3_array to the screen.

Parameters:
vThe d3_array to print
i1-based index of the matrix to print
j1-based index of the vector to print
Returns:
Nothing

Definition at line 218 of file gdbprintlib.cpp.

void pad ( const d3_array v,
int  i,
int  j,
int  k 
)

Print a scalar of a d3_array to the screen.

Parameters:
vThe d3_array to print
i1-based index of the matrix to print
j1-based index of the vector to print
k1-based index of the element to print
Returns:
Nothing

Definition at line 231 of file gdbprintlib.cpp.

void pad ( const i3_array v)

Print a i3_array to the screen.

Parameters:
vThe i3_array to print
Returns:
Nothing

Definition at line 240 of file gdbprintlib.cpp.

void pad ( const i3_array v,
int  i 
)

Print a matrix slice of a i3_array to the screen.

Parameters:
vThe i3_array to print
i1-based index of the matrix to print
Returns:
Nothing

Definition at line 251 of file gdbprintlib.cpp.

void pad ( const i3_array v,
int  i,
int  j 
)

Print a vector slice of a i3_array to the screen.

Parameters:
vThe i3_array to print
i1-based index of the matrix to print
j1-based index of the vector to print
Returns:
Nothing

Definition at line 263 of file gdbprintlib.cpp.

void pad ( const i3_array v,
int  i,
int  j,
int  k 
)

Print a scalar of a i3_array to the screen.

Parameters:
vThe i3_array to print
i1-based index of the matrix to print
j1-based index of the vector to print
k1-based index of the element to print
Returns:
Nothing

Definition at line 276 of file gdbprintlib.cpp.

void pad ( const i4_array v)

Print a i4_array to the screen.

Parameters:
vThe i4_array to print
Returns:
Nothing

Definition at line 286 of file gdbprintlib.cpp.

void pad ( const i4_array v,
int  i 
)

Print a 3D slice of a i4_array to the screen.

Parameters:
vThe i4_array to print
i1-based index of the 3D object to print
Returns:
Nothing

Definition at line 297 of file gdbprintlib.cpp.

void pad ( const i4_array v,
int  i,
int  j 
)

Print a matrix slice of a i4_array to the screen.

Parameters:
vThe i4_array to print
i1-based index of the 3D object to print
j1-based index of the matrix to print
Returns:
Nothing

Definition at line 309 of file gdbprintlib.cpp.

void pad ( const i4_array v,
int  i,
int  j,
int  k 
)

Print a matrix slice of a i4_array to the screen.

Parameters:
vThe i4_array to print
i1-based index of the 3D object to print
j1-based index of the matrix to print
Returns:
Nothing

Definition at line 321 of file gdbprintlib.cpp.

void pad ( const i4_array v,
int  i,
int  j,
int  k,
int  l 
)

Print a scalar of a i4_array to the screen.

Parameters:
vThe i4_array to print
i1-based index of the 3D object to print
j1-based index of the matrix to print
k1-based index of the vector to print
l1-based index of the element to print
Returns:
Nothing

Definition at line 335 of file gdbprintlib.cpp.

void pad ( const dvar_vector v)

Print a dvar_vector to the screen.

Parameters:
vThe dvar_vector
Returns:
Nothing

Definition at line 345 of file gdbprintlib.cpp.

void pad ( const dvar_vector v,
int  i 
)

Print an element of a dvar_vector to the screen.

Parameters:
vThe dvar_vector
i1-based index of the element to be printed
Returns:
Nothing

Definition at line 356 of file gdbprintlib.cpp.

void pad ( const prevariable v)

Print a prevariable to the screen.

Parameters:
vThe prevariable to print
Returns:
Nothing

Definition at line 365 of file gdbprintlib.cpp.

void pad ( const dvector v)

Print a dvector to the screen.

Parameters:
vThe dvector to print
Returns:
Nothing

Definition at line 375 of file gdbprintlib.cpp.

void pad ( const ivector v)

Print an ivector to the screen.

Parameters:
vThe ivector to print
Returns:
Nothing

Definition at line 385 of file gdbprintlib.cpp.

void pad ( const dvar_matrix v)

Print a dvar_matrix to the screen.

Parameters:
vThe dvar_matrix to print
Returns:
Nothing

Definition at line 395 of file gdbprintlib.cpp.

void pad ( const dvar_matrix v,
int  i 
)

Print a vector slice of a dvar_matrix to the screen.

Parameters:
vThe dvar_matrix to print
i1-based index of the vector to be printed
Returns:
Nothing

Definition at line 406 of file gdbprintlib.cpp.

void pad ( const dvar_matrix v,
int  i,
int  j 
)

Print a scalar of a dvar_matrix to the screen.

Parameters:
vThe dvar_matrix to print
i1-based index of the vector to be printed
j1-based index of the element to be printed
Returns:
Nothing

Definition at line 418 of file gdbprintlib.cpp.

void pad ( const dmatrix v)

Print a dmatrix to the screen.

Parameters:
vThe dmatrix to print
Returns:
Nothing

Definition at line 428 of file gdbprintlib.cpp.

void pad ( const dfsdmat v)

Print a dfsdmat (a matrix) to the screen.

Parameters:
vThe dfsdmat to print
Returns:
Nothing

Definition at line 438 of file gdbprintlib.cpp.

void pad ( const imatrix v)

Print a imatrix to the screen.

Parameters:
vThe imatrix to print
Returns:
Nothing

Definition at line 449 of file gdbprintlib.cpp.

void pad ( const imatrix v,
int  i 
)

Print a vector slice of an imatrix to the screen.

Parameters:
vThe imatrix to print
i1-based index of the vector to be printed
Returns:
Nothing

Definition at line 460 of file gdbprintlib.cpp.

void pad ( const imatrix v,
int  i,
int  j 
)

Print a scalar of an imatrix to the screen.

Parameters:
vThe imatrix to print
i1-based index of the vector to be printed
j1-based index of the element to be printed
Returns:
Nothing

Definition at line 472 of file gdbprintlib.cpp.

void padp ( const dmatrix v,
int  i 
)

Print a vector slice of a dmatrix to the screen, with 12 significant figures.

Parameters:
vThe dmatrix to print
i1-based index of the vector to be printed
Returns:
Nothing

Definition at line 504 of file gdbprintlib.cpp.

void padp ( const dvar_matrix v,
int  i 
)

Print a vector slice of a dvar_matrix to the screen, with 12 significant figures.

Parameters:
vThe dvar_matrix to print
i1-based index of the vector to be printed
Returns:
Nothing

Definition at line 515 of file gdbprintlib.cpp.

void pads ( const dvar_vector v)

Print a dvar_vector to the screen in scientific notation, with 5 significant figures.

Parameters:
vThe dvar_vector
Returns:
Nothing

Definition at line 493 of file gdbprintlib.cpp.

void pads ( const dvar_vector v,
int  i 
)

Print an element of a dvar_vector to the screen in scientific notation.

Parameters:
vThe dvar_vector
i1-based index of the element to be printed
Returns:
Nothing

Definition at line 483 of file gdbprintlib.cpp.

void padsum ( const dvar_vector v)

Print the sum of a dvar_vector to the screen.

Parameters:
vThe dvar_vector
Returns:
Nothing

Definition at line 525 of file gdbprintlib.cpp.

void padsum ( const dvector v)

Print the sum of a dvector to the screen.

Parameters:
vThe dvector
Returns:
Nothing

Definition at line 535 of file gdbprintlib.cpp.

void padsum ( const ivector v)

Print the sum of an ivector to the screen.

Parameters:
vThe ivector
Returns:
Nothing

Definition at line 545 of file gdbprintlib.cpp.

void padsum ( const dvar_matrix v)

Print the sum of a dvar_matrix to the screen.

Parameters:
vThe dvar_matrix
Returns:
Nothing

Definition at line 555 of file gdbprintlib.cpp.

void padsum ( const dmatrix v)

Print the sum of a dmatrix to the screen.

Parameters:
vThe dmatrix
Returns:
Nothing

Definition at line 565 of file gdbprintlib.cpp.

void padsum ( const imatrix v)

Print the sum of an imatrix to the screen.

Parameters:
vThe imatrix
Returns:
Nothing

Definition at line 575 of file gdbprintlib.cpp.