classfilval_1_1Reduce.tex 4.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. \hypertarget{classfilval_1_1Reduce}{}\section{filval\+:\+:Reduce$<$ T $>$ Class Template Reference}
  2. \label{classfilval_1_1Reduce}\index{filval\+::\+Reduce$<$ T $>$@{filval\+::\+Reduce$<$ T $>$}}
  3. \hyperlink{classfilval_1_1Reduce}{Reduce} a \hyperlink{classfilval_1_1Value}{Value} of type vector$<$\+T$>$ to just a T.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for filval\+:\+:Reduce$<$ T $>$\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=350pt]{classfilval_1_1Reduce__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. Collaboration diagram for filval\+:\+:Reduce$<$ T $>$\+:
  14. \nopagebreak
  15. \begin{figure}[H]
  16. \begin{center}
  17. \leavevmode
  18. \includegraphics[width=340pt]{classfilval_1_1Reduce__coll__graph}
  19. \end{center}
  20. \end{figure}
  21. \subsection*{Public Member Functions}
  22. \begin{DoxyCompactItemize}
  23. \item
  24. \hypertarget{classfilval_1_1Reduce_a64db8c7153ee1ddce2f2db01f77afc2c}{}\label{classfilval_1_1Reduce_a64db8c7153ee1ddce2f2db01f77afc2c}
  25. {\bfseries Reduce} (const std\+::string \&\hyperlink{classfilval_1_1GenValue_a007e38c03ee041c2a657afa3d6e91ab1}{name}, std\+::function$<$ T(std\+::vector$<$ T $>$)$>$ reduce, \hyperlink{classfilval_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$v)
  26. \item
  27. \hypertarget{classfilval_1_1Reduce_a8834d0f43fb9cf687aade04bcf04981a}{}\label{classfilval_1_1Reduce_a8834d0f43fb9cf687aade04bcf04981a}
  28. {\bfseries Reduce} (const std\+::string \&\hyperlink{classfilval_1_1GenValue_a007e38c03ee041c2a657afa3d6e91ab1}{name}, std\+::function$<$ T(std\+::vector$<$ T $>$)$>$ reduce, const std\+::string \&v\+\_\+name)
  29. \end{DoxyCompactItemize}
  30. \subsection*{Private Member Functions}
  31. \begin{DoxyCompactItemize}
  32. \item
  33. void \hyperlink{classfilval_1_1Reduce_a7f6bc3bed99c9d41e045f675895d8f67}{update\+\_\+value} ()
  34. \begin{DoxyCompactList}\small\item\em Updates the internal value. \end{DoxyCompactList}\end{DoxyCompactItemize}
  35. \subsection*{Private Attributes}
  36. \begin{DoxyCompactItemize}
  37. \item
  38. \hypertarget{classfilval_1_1Reduce_a0bcdfd0837598bcf16547da181d3d8a2}{}\label{classfilval_1_1Reduce_a0bcdfd0837598bcf16547da181d3d8a2}
  39. std\+::function$<$ T(std\+::vector$<$ T $>$)$>$ {\bfseries reduce}
  40. \item
  41. \hypertarget{classfilval_1_1Reduce_aa262aa756388d84b37bc2cf47022b515}{}\label{classfilval_1_1Reduce_aa262aa756388d84b37bc2cf47022b515}
  42. \hyperlink{classfilval_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$ {\bfseries v}
  43. \end{DoxyCompactItemize}
  44. \subsection*{Additional Inherited Members}
  45. \subsection{Detailed Description}
  46. \subsubsection*{template$<$typename T$>$\newline
  47. class filval\+::\+Reduce$<$ T $>$}
  48. \hyperlink{classfilval_1_1Reduce}{Reduce} a \hyperlink{classfilval_1_1Value}{Value} of type vector$<$\+T$>$ to just a T.
  49. This is useful functionality to model, for instance, calculating the maximum element of a vector, or a the mean. See child classes for specific implementations.
  50. \subsection{Member Function Documentation}
  51. \hypertarget{classfilval_1_1Reduce_a7f6bc3bed99c9d41e045f675895d8f67}{}\label{classfilval_1_1Reduce_a7f6bc3bed99c9d41e045f675895d8f67}
  52. \index{filval\+::\+Reduce@{filval\+::\+Reduce}!update\+\_\+value@{update\+\_\+value}}
  53. \index{update\+\_\+value@{update\+\_\+value}!filval\+::\+Reduce@{filval\+::\+Reduce}}
  54. \subsubsection{\texorpdfstring{update\+\_\+value()}{update\_value()}}
  55. {\footnotesize\ttfamily template$<$typename T$>$ \\
  56. void \hyperlink{classfilval_1_1Reduce}{filval\+::\+Reduce}$<$ T $>$\+::update\+\_\+value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [private]}, {\ttfamily [virtual]}}
  57. Updates the internal value.
  58. This function should be overridden by any child class to do the actual work of updating value based on whatever rules the class chooses. Normally, this consists of geting the values from some associated \hyperlink{classfilval_1_1Value}{Value} objects, doing some calculation on them, and storing the result in value.
  59. Implements \hyperlink{classfilval_1_1DerivedValue_a74e04450a550454510329a9e6b941304}{filval\+::\+Derived\+Value$<$ T $>$}.
  60. Here is the call graph for this function\+:
  61. \nopagebreak
  62. \begin{figure}[H]
  63. \begin{center}
  64. \leavevmode
  65. \includegraphics[width=333pt]{classfilval_1_1Reduce_a7f6bc3bed99c9d41e045f675895d8f67_cgraph}
  66. \end{center}
  67. \end{figure}
  68. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  69. \item
  70. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}