Commit 60f99127 authored by Karl Wette's avatar Karl Wette

Doxygen: add Demod hotloops as files within ComputeFstat_Demod.c documentation module

- use \snipppet to include hotloop code in corresponding .i files
parent 1dc91c3c
......@@ -29,7 +29,14 @@
// must be #included last, as it redefines meaning of 'vector'
#include <altivec.h>
// ----- Akos hotloop Altivec code (Dterms=8) ----------
///
/// \file ComputeFstat_DemodHL_Altivec.c
/// \ingroup ComputeFstat_Demod_c
/// \brief Akos hotloop Altivec code (Dterms=8)
///
/// \snippet ComputeFstat_DemodHL_Altivec.i hotloop
///
#define FUNC XLALComputeFaFb_Altivec
#define HOTLOOP_SOURCE "ComputeFstat_DemodHL_Altivec.i"
#include "ComputeFstat_Demod_ComputeFaFb.c"
......@@ -17,6 +17,7 @@
// MA 02111-1307 USA
//
/// [hotloop]
{
{
REAL4 s_alpha, c_alpha; /* sin(2pi kappa_alpha) and (cos(2pi kappa_alpha)-1) */
......@@ -104,3 +105,4 @@
XLALSinCos2PiLUT( &imagQ, &realQ, _lambda_alpha );
}
}
/// [hotloop]
......@@ -26,7 +26,14 @@
#include <lal/Factorial.h>
#include <lal/SinCosLUT.h>
// ----- old (pre-Akos) LALDemod hotloop variant (unrestricted Dterms) ----------
///
/// \file ComputeFstat_DemodHL_Generic.c
/// \ingroup ComputeFstat_Demod_c
/// \brief Old (pre-Akos) LALDemod hotloop variant (unrestricted Dterms)
///
/// \snippet ComputeFstat_DemodHL_Generic.i hotloop
///
#define FUNC XLALComputeFaFb_Generic
#define HOTLOOP_SOURCE "ComputeFstat_DemodHL_Generic.i"
#include "ComputeFstat_Demod_ComputeFaFb.c"
......@@ -17,6 +17,7 @@
// MA 02111-1307 USA
//
/// [hotloop]
{
/* old 'vanilla' (pre-Akos) LALDemod hotloop algorithm, unrestricted
* Dterms: based on version 5b0343e65a5a820d3e21a2afd9ba72123b05309c of
......@@ -61,3 +62,4 @@
/* real- and imaginary part of e^{i 2 pi lambda_alpha } */
XLALSinCos2PiLUT ( &imagQ, &realQ, lambda_alpha );
}
/// [hotloop]
......@@ -26,7 +26,14 @@
#include <lal/Factorial.h>
#include <lal/SinCosLUT.h>
// ----- Akos generic hotloop code (Dterms <= 20) ----------
///
/// \file ComputeFstat_DemodHL_OptC.c
/// \ingroup ComputeFstat_Demod_c
/// \brief Akos generic hotloop code (Dterms <= 20)
///
/// \snippet ComputeFstat_DemodHL_OptC.i hotloop
///
#define FUNC XLALComputeFaFb_OptC
#define HOTLOOP_SOURCE "ComputeFstat_DemodHL_OptC.i"
#include "ComputeFstat_Demod_ComputeFaFb.c"
......@@ -17,6 +17,7 @@
// MA 02111-1307 USA
//
/// [hotloop]
/* NOTE: sin[ 2pi (Dphi_alpha - k) ] = sin [ 2pi Dphi_alpha ], therefore
* the trig-functions need to be calculated only once!
* We choose the value sin[ 2pi(Dphi_alpha - kstar) ] because it is the
......@@ -69,3 +70,4 @@
/* real- and imaginary part of e^{i 2 pi lambda_alpha } */
XLALSinCos2PiLUT ( &imagQ, &realQ, lambda_alpha );
}
/// [hotloop]
......@@ -28,7 +28,14 @@
#include "SinCosLUT.i"
// ----- Akos hotloop precalc SSE code (Dterms=8) ----------
///
/// \file ComputeFstat_DemodHL_SSE.c
/// \ingroup ComputeFstat_Demod_c
/// \brief Akos hotloop precalc SSE code (Dterms=8)
///
/// \snippet ComputeFstat_DemodHL_SSE.i hotloop
///
#define FUNC XLALComputeFaFb_SSE
#define HOTLOOP_SOURCE "ComputeFstat_DemodHL_SSE.i"
#include "ComputeFstat_Demod_ComputeFaFb.c"
......@@ -17,6 +17,7 @@
// MA 02111-1307 USA
//
/// [hotloop]
/** SSE version with precalculated divisors from Akos */
{
{
......@@ -188,3 +189,4 @@
}
}
/// [hotloop]
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment