classfv_1_1ZipMapFour.tex 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. \hypertarget{classfv_1_1ZipMapFour}{}\section{fv\+:\+:Zip\+Map\+Four$<$ R, T $>$ Class Template Reference}
  2. \label{classfv_1_1ZipMapFour}\index{fv\+::\+Zip\+Map\+Four$<$ R, T $>$@{fv\+::\+Zip\+Map\+Four$<$ R, T $>$}}
  3. 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$>$.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for fv\+:\+:Zip\+Map\+Four$<$ R, T $>$\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=210pt]{classfv_1_1ZipMapFour__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. Collaboration diagram for fv\+:\+:Zip\+Map\+Four$<$ R, T $>$\+:
  14. \nopagebreak
  15. \begin{figure}[H]
  16. \begin{center}
  17. \leavevmode
  18. \includegraphics[width=350pt]{classfv_1_1ZipMapFour__coll__graph}
  19. \end{center}
  20. \end{figure}
  21. \subsection*{Public Member Functions}
  22. \begin{DoxyCompactItemize}
  23. \item
  24. \hypertarget{classfv_1_1ZipMapFour_abe592d190561a6472f134c62ba124a0c}{}\label{classfv_1_1ZipMapFour_abe592d190561a6472f134c62ba124a0c}
  25. {\bfseries Zip\+Map\+Four} (\hyperlink{classfv_1_1Function}{Function}$<$ R(T, T, T, T)$>$ \&f, \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$v1, \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$v2, \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$v3, \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$v4, const std\+::string alias=\char`\"{}\char`\"{})
  26. \item
  27. \hypertarget{classfv_1_1ZipMapFour_a5509c463af07fadc89c5b9e3af50956c}{}\label{classfv_1_1ZipMapFour_a5509c463af07fadc89c5b9e3af50956c}
  28. {\bfseries Zip\+Map\+Four} (\hyperlink{classfv_1_1Function}{Function}$<$ R(T, T, T, T)$>$ \&f, const std\+::string \&label1, const std\+::string \&label2, const std\+::string \&label3, const std\+::string \&label4, const std\+::string alias=\char`\"{}\char`\"{})
  29. \end{DoxyCompactItemize}
  30. \subsection*{Private Member Functions}
  31. \begin{DoxyCompactItemize}
  32. \item
  33. void \hyperlink{classfv_1_1ZipMapFour_a812747fdc043c776951ceb93a1085915}{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_1ZipMapFour_ad64b5654f8c745900a1b6d8aa6b9b681}{}\label{classfv_1_1ZipMapFour_ad64b5654f8c745900a1b6d8aa6b9b681}
  39. \hyperlink{classfv_1_1Function}{Function}$<$ R(T, T, T, T)$>$ \& {\bfseries f}
  40. \item
  41. \hypertarget{classfv_1_1ZipMapFour_ad1d5d707ed951de86236f4ccb7b4822a}{}\label{classfv_1_1ZipMapFour_ad1d5d707ed951de86236f4ccb7b4822a}
  42. \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$ {\bfseries v1}
  43. \item
  44. \hypertarget{classfv_1_1ZipMapFour_a7372a10312b93e50e8851244caa82e14}{}\label{classfv_1_1ZipMapFour_a7372a10312b93e50e8851244caa82e14}
  45. \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$ {\bfseries v2}
  46. \item
  47. \hypertarget{classfv_1_1ZipMapFour_aa403e20095880e9ae7f0853ca47a7166}{}\label{classfv_1_1ZipMapFour_aa403e20095880e9ae7f0853ca47a7166}
  48. \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$ {\bfseries v3}
  49. \item
  50. \hypertarget{classfv_1_1ZipMapFour_a0e2fa2764e5c0023336a5d294fe53c00}{}\label{classfv_1_1ZipMapFour_a0e2fa2764e5c0023336a5d294fe53c00}
  51. \hyperlink{classfv_1_1Value}{Value}$<$ std\+::vector$<$ T $>$ $>$ $\ast$ {\bfseries v4}
  52. \end{DoxyCompactItemize}
  53. \subsection*{Additional Inherited Members}
  54. \subsection{Detailed Description}
  55. \subsubsection*{template$<$typename R, typename T$>$\newline
  56. class fv\+::\+Zip\+Map\+Four$<$ R, T $>$}
  57. 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$>$.
  58. This is used in, for instance, calculating the energy of a set of particles when one has separate arrays containing pt, eta, phi, and mass. These arrays are first wrapped up in Vector\+Wrappers and then passes along with a function to calculate the energy into a \hyperlink{classfv_1_1ZipMapFour}{Zip\+Map\+Four}. The result of this calculation is a new vector containing the energy for each particle. Note that if the input vectors are not all the same size, calculations are only performed up to the size of the shortest. \begin{DoxySeeAlso}{See also}
  59. Mini\+Tree\+Data\+Set
  60. \end{DoxySeeAlso}
  61. \begin{DoxyRefDesc}{Todo}
  62. \item[\hyperlink{todo__todo000001}{Todo}]find way to implement for arbitrary number(and possibly type) of vector inputs. \end{DoxyRefDesc}
  63. \subsection{Member Function Documentation}
  64. \hypertarget{classfv_1_1ZipMapFour_a812747fdc043c776951ceb93a1085915}{}\label{classfv_1_1ZipMapFour_a812747fdc043c776951ceb93a1085915}
  65. \index{fv\+::\+Zip\+Map\+Four@{fv\+::\+Zip\+Map\+Four}!update\+\_\+value@{update\+\_\+value}}
  66. \index{update\+\_\+value@{update\+\_\+value}!fv\+::\+Zip\+Map\+Four@{fv\+::\+Zip\+Map\+Four}}
  67. \subsubsection{\texorpdfstring{update\+\_\+value()}{update\_value()}}
  68. {\footnotesize\ttfamily template$<$typename R , typename T $>$ \\
  69. void \hyperlink{classfv_1_1ZipMapFour}{fv\+::\+Zip\+Map\+Four}$<$ R, T $>$\+::update\+\_\+value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [private]}, {\ttfamily [virtual]}}
  70. Updates the internal value.
  71. 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.
  72. Implements \hyperlink{classfv_1_1DerivedValue_ae59e80a98eb74b95d8961bfe12ee5ec2}{fv\+::\+Derived\+Value$<$ std\+::vector$<$ R $>$ $>$}.
  73. Here is the call graph for this function\+:
  74. \nopagebreak
  75. \begin{figure}[H]
  76. \begin{center}
  77. \leavevmode
  78. \includegraphics[width=350pt]{classfv_1_1ZipMapFour_a812747fdc043c776951ceb93a1085915_cgraph}
  79. \end{center}
  80. \end{figure}
  81. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  82. \item
  83. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}