1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class Vec</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class <A HREF="#DOC.DOCU">Vec</A></H2></H2><BLOCKQUOTE>Vector object.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
<param name=classes value="CObject,MObject.html,CVec,MVec.html">
<param name=before value="M,M">
<param name=after value="Md_,M">
<param name=indent value="0,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.81.1">ptr_is_allocated</A></B>
<DD><I><TT>false</TT> if <TT>ptr</TT> is not allocated by Vec.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.81.2">n</A></B>
<DD><I>Size of the vector</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>real* <B><A HREF="#DOC.81.3">ptr</A></B>
<DD><I>Data of the vector</I>
</DL></P>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.81.4">Vec</A></B>(real* ptr_, int n_dim)
<DD><I>Create a vector from values in <TT>ptr_</TT>.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.81.5">Vec</A></B>(int n_dim)
<DD><I>Create a new vector</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.81.6">copy</A></B>(<!1><A HREF="Vec.html">Vec</A>* vec, int start_i = 0)
<DD><I>Copy the vector <TT>vec</TT> starting from index <TT>start_i</TT></I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.81.7">zero</A></B>()
<DD><I>Zero the matrix</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>real <B><A HREF="#DOC.81.8">norm1</A></B>(<!1><A HREF="Vec.html">Vec</A>* <!1><A HREF="WeightedSumMachine.html#DOC.63.5">weights</A> = NULL)
<DD><I>Compute the norm1</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>real <B><A HREF="#DOC.81.9">norm2</A></B>(<!1><A HREF="Vec.html">Vec</A>* <!1><A HREF="WeightedSumMachine.html#DOC.63.5">weights</A> = NULL)
<DD><I>Compute the norm2</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>real <B><A HREF="#DOC.81.10">normInf</A></B>()
<DD><I>Compute the norm inf</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>real <B><A HREF="#DOC.81.11">iP</A></B>(<!1><A HREF="Vec.html">Vec</A>* vec, int start_i = 0)
<DD><I>Inner product of two vectors from <TT>start_i</TT> downwards</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Vec.html">Vec</A>* <B><A HREF="#DOC.81.12">subVec</A></B>(int dim1, int dim2)
<DD><I>Return a sub-vector.</I>
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="Object.html">Object</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>virtual void <B>init</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int size, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addIOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, int init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addROption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, real init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addBOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, bool init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setIOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int option)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setROption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real option)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setBOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool option)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual void <B>loadFILE</B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual void <B>saveFILE</B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>load</B>(const char* filename)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>save</B>(const char* filename)
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Vector object.
<P></BLOCKQUOTE>
<DL>
<A NAME="ptr_is_allocated"></A>
<A NAME="DOC.81.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool ptr_is_allocated</B></TT>
<DD><TT>false</TT> if <TT>ptr</TT> is not allocated by Vec.
(With the first constructor)
<DL><DT><DD></DL><P>
<A NAME="n"></A>
<A NAME="DOC.81.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int n</B></TT>
<DD>Size of the vector
<DL><DT><DD></DL><P>
<A NAME="ptr"></A>
<A NAME="DOC.81.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>real* ptr</B></TT>
<DD>Data of the vector
<DL><DT><DD></DL><P>
<A NAME="Vec"></A>
<A NAME="DOC.81.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Vec(real* ptr_, int n_dim)</B></TT>
<DD>Create a vector from values in <TT>ptr_</TT>.
(No memory copy).
<DL><DT><DD></DL><P>
<A NAME="Vec"></A>
<A NAME="DOC.81.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Vec(int n_dim)</B></TT>
<DD>Create a new vector
<DL><DT><DD></DL><P>
<A NAME="copy"></A>
<A NAME="DOC.81.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void copy(<!1><A HREF="Vec.html">Vec</A>* vec, int start_i = 0)</B></TT>
<DD>Copy the vector <TT>vec</TT> starting from index <TT>start_i</TT>
<DL><DT><DD></DL><P>
<A NAME="zero"></A>
<A NAME="DOC.81.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void zero()</B></TT>
<DD>Zero the matrix
<DL><DT><DD></DL><P>
<A NAME="norm1"></A>
<A NAME="DOC.81.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>real norm1(<!1><A HREF="Vec.html">Vec</A>* <!1><A HREF="WeightedSumMachine.html#DOC.63.5">weights</A> = NULL)</B></TT>
<DD>Compute the norm1
<DL><DT><DD></DL><P>
<A NAME="norm2"></A>
<A NAME="DOC.81.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>real norm2(<!1><A HREF="Vec.html">Vec</A>* <!1><A HREF="WeightedSumMachine.html#DOC.63.5">weights</A> = NULL)</B></TT>
<DD>Compute the norm2
<DL><DT><DD></DL><P>
<A NAME="normInf"></A>
<A NAME="DOC.81.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>real normInf()</B></TT>
<DD>Compute the norm inf
<DL><DT><DD></DL><P>
<A NAME="iP"></A>
<A NAME="DOC.81.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>real iP(<!1><A HREF="Vec.html">Vec</A>* vec, int start_i = 0)</B></TT>
<DD>Inner product of two vectors from <TT>start_i</TT> downwards
<DL><DT><DD></DL><P>
<A NAME="subVec"></A>
<A NAME="DOC.81.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Vec.html">Vec</A>* subVec(int dim1, int dim2)</B></TT>
<DD>Return a sub-vector.
Note that the memory is shared with the original
vector, so *be carefull*.
<DL><DT><DD></DL><P></DL>
<HR><DL><DT><B>This class has no child classes.</B></DL>
<DL><DT><DT><B>Author:</B><DD>Ronan Collobert (collober@iro.umontreal.ca)
<DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>
|