namespacefv.tex 5.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. \hypertarget{namespacefv}{}\section{fv Namespace Reference}
  2. \label{namespacefv}\index{fv@{fv}}
  3. The namespace containing all filval classes and functions.
  4. \subsection*{Classes}
  5. \begin{DoxyCompactItemize}
  6. \item
  7. class \hyperlink{classfv_1_1BoundValue}{Bound\+Value}
  8. \begin{DoxyCompactList}\small\item\em A generic value owning only a function object. \end{DoxyCompactList}\item
  9. class \hyperlink{classfv_1_1ConstantValue}{Constant\+Value}
  10. \begin{DoxyCompactList}\small\item\em A \hyperlink{classfv_1_1Value}{Value} which always returns the same value, supplied in the constructor. \end{DoxyCompactList}\item
  11. class \hyperlink{classfv_1_1Container}{Container}
  12. \item
  13. class \hyperlink{classfv_1_1ContainerMean}{Container\+Mean}
  14. \item
  15. class \hyperlink{classfv_1_1ContainerVector}{Container\+Vector}
  16. \item
  17. class \hyperlink{classfv_1_1Count}{Count}
  18. \item
  19. class \hyperlink{classfv_1_1DataSet}{Data\+Set}
  20. \item
  21. class \hyperlink{classfv_1_1DerivedValue}{Derived\+Value}
  22. \begin{DoxyCompactList}\small\item\em A generic, derived, value. \end{DoxyCompactList}\item
  23. class \hyperlink{classfv_1_1ElementOf}{Element\+Of}
  24. \begin{DoxyCompactList}\small\item\em Extract the element at a specific index from a vector. \end{DoxyCompactList}\item
  25. class \hyperlink{classfv_1_1Filter}{Filter}
  26. \item
  27. class \hyperlink{classfv_1_1Function}{Function}
  28. \item
  29. class \hyperlink{classfv_1_1Function_3_01R_07ArgTypes_8_8_8_08_4}{Function$<$ R(\+Arg\+Types...)$>$}
  30. \begin{DoxyCompactList}\small\item\em In order to enable proper provenance tracking, and at the same time keep the ability to embed functions into values, the \hyperlink{classfv_1_1Function}{Function} class should be used. \end{DoxyCompactList}\item
  31. class \hyperlink{classfv_1_1GenContainer}{Gen\+Container}
  32. \item
  33. class \hyperlink{classfv_1_1GenFunction}{Gen\+Function}
  34. \begin{DoxyCompactList}\small\item\em Parent class to all \hyperlink{classfv_1_1Function}{Function} classes. \end{DoxyCompactList}\item
  35. class \hyperlink{classfv_1_1GenValue}{Gen\+Value}
  36. \item
  37. class \hyperlink{classfv_1_1Max}{Max}
  38. \begin{DoxyCompactList}\small\item\em Find and return the maximum value of a vector. \end{DoxyCompactList}\item
  39. class \hyperlink{classfv_1_1MaxIndex}{Max\+Index}
  40. \begin{DoxyCompactList}\small\item\em Find and return the maximum value of a vector and its index. \end{DoxyCompactList}\item
  41. class \hyperlink{classfv_1_1Mean}{Mean}
  42. \begin{DoxyCompactList}\small\item\em Calculate the mean value of a vector. \end{DoxyCompactList}\item
  43. class \hyperlink{classfv_1_1Min}{Min}
  44. \begin{DoxyCompactList}\small\item\em Find and return the minimum value of a vector. \end{DoxyCompactList}\item
  45. class \hyperlink{classfv_1_1MinIndex}{Min\+Index}
  46. \begin{DoxyCompactList}\small\item\em Find and return the minimum value of a vector and its index. \end{DoxyCompactList}\item
  47. class \hyperlink{classfv_1_1ObservedValue}{Observed\+Value}
  48. \begin{DoxyCompactList}\small\item\em A generic, observed, value. \end{DoxyCompactList}\item
  49. class \hyperlink{classfv_1_1Pair}{Pair}
  50. \begin{DoxyCompactList}\small\item\em Creates a std\+::pair type from a two other \hyperlink{classfv_1_1Value}{Value} objects. \end{DoxyCompactList}\item
  51. class \hyperlink{classfv_1_1PointerValue}{Pointer\+Value}
  52. \begin{DoxyCompactList}\small\item\em A \hyperlink{classfv_1_1Value}{Value} of a pointer. \end{DoxyCompactList}\item
  53. class \hyperlink{classfv_1_1Range}{Range}
  54. \begin{DoxyCompactList}\small\item\em Calculate the range of the values in a vector. \end{DoxyCompactList}\item
  55. class \hyperlink{classfv_1_1RangeFilter}{Range\+Filter}
  56. \item
  57. class \hyperlink{classfv_1_1Reduce}{Reduce}
  58. \begin{DoxyCompactList}\small\item\em \hyperlink{classfv_1_1Reduce}{Reduce} a \hyperlink{classfv_1_1Value}{Value} of type vector$<$\+T$>$ to just a T. \end{DoxyCompactList}\item
  59. class \hyperlink{classfv_1_1ReduceIndex}{Reduce\+Index}
  60. \begin{DoxyCompactList}\small\item\em Similar to \hyperlink{classfv_1_1Reduce}{Reduce}, but returns a pair of a T and an int. \end{DoxyCompactList}\item
  61. class \hyperlink{classfv_1_1Value}{Value}
  62. \begin{DoxyCompactList}\small\item\em A generic value. \end{DoxyCompactList}\item
  63. class \hyperlink{classfv_1_1WrapperVector}{Wrapper\+Vector}
  64. \begin{DoxyCompactList}\small\item\em A std\+::vector wrapper around a C-\/style array. \end{DoxyCompactList}\item
  65. class \hyperlink{classfv_1_1ZipMapFour}{Zip\+Map\+Four}
  66. \begin{DoxyCompactList}\small\item\em Takes a set of four \hyperlink{classfv_1_1Value}{Value}$<$std\+::vector$<$\+T$>$ $>$ objects and a function of four Ts and returns a std\+::vector$<$\+R$>$. \end{DoxyCompactList}\end{DoxyCompactItemize}
  67. \subsection*{Typedefs}
  68. \begin{DoxyCompactItemize}
  69. \item
  70. \hypertarget{namespacefv_a99804eba279e6002492d49bbd54e1938}{}\label{namespacefv_a99804eba279e6002492d49bbd54e1938}
  71. typedef std\+::map$<$ std\+::string, \hyperlink{classfv_1_1GenContainer}{Gen\+Container} $\ast$ $>$ {\bfseries Container\+Set}
  72. \item
  73. \hypertarget{namespacefv_acc10056e9b78553b6a5b2110e63456e9}{}\label{namespacefv_acc10056e9b78553b6a5b2110e63456e9}
  74. typedef std\+::map$<$ std\+::string, \hyperlink{classfv_1_1GenValue}{Gen\+Value} $\ast$ $>$ {\bfseries Value\+Set}
  75. \end{DoxyCompactItemize}
  76. \subsection*{Enumerations}
  77. \begin{DoxyCompactItemize}
  78. \item
  79. \hypertarget{namespacefv_a16a191c4b8935d4c7c5aad79fc4ea97e}{}\label{namespacefv_a16a191c4b8935d4c7c5aad79fc4ea97e}
  80. enum {\bfseries Save\+Option} \{ {\bfseries P\+NG} = 0,
  81. {\bfseries P\+DF} = 1,
  82. {\bfseries R\+O\+OT} = 2
  83. \}
  84. \end{DoxyCompactItemize}
  85. \subsection*{Functions}
  86. \begin{DoxyCompactItemize}
  87. \item
  88. \hypertarget{namespacefv_a12225ad5af727a02b469015810b7f83f}{}\label{namespacefv_a12225ad5af727a02b469015810b7f83f}
  89. std\+::ostream \& {\bfseries operator$<$$<$} (std\+::ostream \&os, \hyperlink{classfv_1_1GenValue}{Gen\+Value} \&gv)
  90. \end{DoxyCompactItemize}
  91. \subsection{Detailed Description}
  92. The namespace containing all filval classes and functions.