classfv_1_1ReduceIndex.tex 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. \hypertarget{classfv_1_1ReduceIndex}{}\section{fv\+:\+:Reduce\+Index$<$ T $>$ Class Template Reference}
  2. \label{classfv_1_1ReduceIndex}\index{fv\+::\+Reduce\+Index$<$ T $>$@{fv\+::\+Reduce\+Index$<$ T $>$}}
  3. Similar to \hyperlink{classfv_1_1Reduce}{Reduce}, but returns a pair of a T and an int.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for fv\+:\+:Reduce\+Index$<$ T $>$\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=310pt]{classfv_1_1ReduceIndex__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. Collaboration diagram for fv\+:\+:Reduce\+Index$<$ T $>$\+:
  14. \nopagebreak
  15. \begin{figure}[H]
  16. \begin{center}
  17. \leavevmode
  18. \includegraphics[width=300pt]{classfv_1_1ReduceIndex__coll__graph}
  19. \end{center}
  20. \end{figure}
  21. \subsection*{Public Member Functions}
  22. \begin{DoxyCompactItemize}
  23. \item
  24. \hypertarget{classfv_1_1ReduceIndex_ad118a68262cfa9519bb7030502115ca9}{}\label{classfv_1_1ReduceIndex_ad118a68262cfa9519bb7030502115ca9}
  25. {\bfseries Reduce\+Index} (\hyperlink{classfv_1_1Function}{Function}$<$ std\+::pair$<$ T, int $>$(std\+::vector$<$ T $>$)$>$ \&reduce, \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$v, const std\+::string alias=\char`\"{}\char`\"{})
  26. \item
  27. \hypertarget{classfv_1_1ReduceIndex_a0036e4d7f41cce518020a40666506a57}{}\label{classfv_1_1ReduceIndex_a0036e4d7f41cce518020a40666506a57}
  28. {\bfseries Reduce\+Index} (\hyperlink{classfv_1_1Function}{Function}$<$ std\+::pair$<$ T, int $>$(std\+::vector$<$ T $>$)$>$ \&reduce, const std\+::string \&v\+\_\+name, const std\+::string alias=\char`\"{}\char`\"{})
  29. \end{DoxyCompactItemize}
  30. \subsection*{Private Member Functions}
  31. \begin{DoxyCompactItemize}
  32. \item
  33. void \hyperlink{classfv_1_1ReduceIndex_a462bffebe2a93c940aca526566d48e37}{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{classfv_1_1ReduceIndex_a36e2279f62f6480d882be0bc08cba098}{}\label{classfv_1_1ReduceIndex_a36e2279f62f6480d882be0bc08cba098}
  39. \hyperlink{classfv_1_1Function}{Function}$<$ std\+::pair$<$ T, int $>$std\+::vector$<$ T $>$)$>$ \& {\bfseries reduce}
  40. \item
  41. \hypertarget{classfv_1_1ReduceIndex_a964863091c91f86b5718973f010dbb00}{}\label{classfv_1_1ReduceIndex_a964863091c91f86b5718973f010dbb00}
  42. \hyperlink{classfv_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 fv\+::\+Reduce\+Index$<$ T $>$}
  48. Similar to \hyperlink{classfv_1_1Reduce}{Reduce}, but returns a pair of a T and an int.
  49. This is useful if you need to know where in the vector exists the element being returned.
  50. \subsection{Member Function Documentation}
  51. \hypertarget{classfv_1_1ReduceIndex_a462bffebe2a93c940aca526566d48e37}{}\label{classfv_1_1ReduceIndex_a462bffebe2a93c940aca526566d48e37}
  52. \index{fv\+::\+Reduce\+Index@{fv\+::\+Reduce\+Index}!update\+\_\+value@{update\+\_\+value}}
  53. \index{update\+\_\+value@{update\+\_\+value}!fv\+::\+Reduce\+Index@{fv\+::\+Reduce\+Index}}
  54. \subsubsection{\texorpdfstring{update\+\_\+value()}{update\_value()}}
  55. {\footnotesize\ttfamily template$<$typename T $>$ \\
  56. void \hyperlink{classfv_1_1ReduceIndex}{fv\+::\+Reduce\+Index}$<$ 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{classfv_1_1Value}{Value} objects, doing some calculation on them, and storing the result in value.
  59. Implements \hyperlink{classfv_1_1DerivedValue_ae59e80a98eb74b95d8961bfe12ee5ec2}{fv\+::\+Derived\+Value$<$ std\+::pair$<$ T, int $>$ $>$}.
  60. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  61. \item
  62. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}