coding conventions
authorrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 23 Mar 2010 08:59:54 +0000 (08:59 +0000)
committerrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 23 Mar 2010 08:59:54 +0000 (08:59 +0000)
HLT/TPCLib/tracking-ca/AliHLTTPCCAGPUTrackerNVCC.cxx
HLT/TPCLib/tracking-ca/AliHLTTPCCAGPUTrackerNVCC.h

index 5fa74b7..618c9dc 100644 (file)
@@ -1,3 +1,4 @@
+// $Id$
 // **************************************************************************
 // This file is property of and copyright by the ALICE HLT Project          *
 // ALICE Experiment at CERN, All rights reserved.                           *
 //                                                                          *
 //***************************************************************************
 
+//  @file   AliHLTTPCCAGPUTrackerNVCC.cxx
+//  @author David Rohr, Sergey Gorbunov
+//  @date   
+//  @brief  TPC CA Tracker for the NVIDIA GPU
+//  @note 
+
 #include "AliHLTTPCCAGPUTrackerNVCC.h"
 
 AliHLTTPCCAGPUTrackerNVCC::AliHLTTPCCAGPUTrackerNVCC() :
@@ -31,41 +38,58 @@ AliHLTTPCCAGPUTrackerNVCC::AliHLTTPCCAGPUTrackerNVCC() :
        fOutputControl(NULL),
        fThreadId(0),
        fCudaInitialized(0)
-       {};
+       
+{
+  // see header file for class documentation
+  // or
+  // refer to README to build package
+  // or
+  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+};
 
-AliHLTTPCCAGPUTrackerNVCC::~AliHLTTPCCAGPUTrackerNVCC() {};
+AliHLTTPCCAGPUTrackerNVCC::~AliHLTTPCCAGPUTrackerNVCC() 
+{
+  // see header file for class documentation
+};
 
 void AliHLTTPCCAGPUTrackerNVCC::ReleaseGlobalLock(void* sem)
 {
+  // see header file for class documentation
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::CheckMemorySizes(int sliceCount)
 {
+  // see header file for class documentation
   return(0);
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::InitGPU(int sliceCount, int forceDeviceID)
 {
+  // see header file for class documentation
   return(0);
 }
 
 template <class T> inline T* AliHLTTPCCAGPUTrackerNVCC::alignPointer(T* ptr, int alignment)
 {
+  // see header file for class documentation
        return((T*) NULL);
 }
 
 bool AliHLTTPCCAGPUTrackerNVCC::CudaFailedMsg(cudaError_t error)
 {
+  // see header file for class documentation
        return(true);
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::CUDASync(char* state)
 {
+  // see header file for class documentation
        return(0);
 }
 
 void AliHLTTPCCAGPUTrackerNVCC::SetDebugLevel(const int dwLevel, std::ostream* const NewOutFile)
 {
+  // see header file for class documentation
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::SetGPUTrackerOption(char* OptionName, int /*OptionValue*/)
@@ -73,38 +97,48 @@ int AliHLTTPCCAGPUTrackerNVCC::SetGPUTrackerOption(char* OptionName, int /*Optio
        return(0);
 }
 
-void AliHLTTPCCAGPUTrackerNVCC::StandalonePerfTime(int /*iSlice*/, int /*i*/) {}
+void AliHLTTPCCAGPUTrackerNVCC::StandalonePerfTime(int /*iSlice*/, int /*i*/) 
+{
+  // see header file for class documentation
+}
 
 void AliHLTTPCCAGPUTrackerNVCC::DumpRowBlocks(AliHLTTPCCATracker* tracker, int iSlice, bool check)
 {
+  // see header file for class documentation
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::Reconstruct(AliHLTTPCCASliceOutput** pOutput, AliHLTTPCCAClusterData* pClusterData, int firstSlice, int sliceCountLocal)
 {
+  // see header file for class documentation
        return(0);
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::InitializeSliceParam(int iSlice, AliHLTTPCCAParam &param)
 {
+  // see header file for class documentation
        return(0);
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::ExitGPU()
 {
+  // see header file for class documentation
        return(0);
 }
 
 void AliHLTTPCCAGPUTrackerNVCC::SetOutputControl( AliHLTTPCCASliceOutput::outputControlStruct* val)
 {
+  // see header file for class documentation
 }
 
 int AliHLTTPCCAGPUTrackerNVCC::GetThread()
 {
+  // see header file for class documentation
     return(0);
 }
 
 unsigned long long int* AliHLTTPCCAGPUTrackerNVCC::PerfTimer(int iSlice, unsigned int i)
 {
+  // see header file for class documentation
     static unsigned long long int tmp;
     return(&tmp);
 }
@@ -123,10 +157,12 @@ int AliHLTTPCCAGPUTrackerNVCC::GetSliceCount() const
 
 AliHLTTPCCAGPUTracker* AliHLTTPCCAGPUTrackerNVCCCreate()
 {
+  // see header file for class documentation
        return new AliHLTTPCCAGPUTrackerNVCC;
 } 
 void AliHLTTPCCAGPUTrackerNVCCDestroy(AliHLTTPCCAGPUTracker* ptr)
 {
+  // see header file for class documentation
        delete ptr;
 }
 
index f9454a4..52a7315 100644 (file)
@@ -1,3 +1,6 @@
+//-*- Mode: C++ -*-
+// $Id$
+
 // ************************************************************************
 // This file is property of and copyright by the ALICE HLT Project        *
 // ALICE Experiment at CERN, All rights reserved.                         *
@@ -5,6 +8,12 @@
 //                                                                        *
 //*************************************************************************
 
+//  @file   AliHLTTPCCAGPUTrackerNVCC.h
+//  @author David Rohr, Sergey Gorbunov
+//  @date   
+//  @brief  TPC CA Tracker for the NVIDIA GPU
+//  @note 
+
 #ifndef ALIHLTTPCCAGPUTRACKERNVCC_H
 #define ALIHLTTPCCAGPUTRACKERNVCC_H
 
@@ -50,9 +59,9 @@ private:
        void ReleaseGlobalLock(void* sem);
        int CheckMemorySizes(int sliceCount);
 
-       AliHLTTPCCATracker *fGpuTracker;
-       void* fGPUMemory;
-       void* fHostLockedMemory;
+       AliHLTTPCCATracker *fGpuTracker; //!
+       void* fGPUMemory; //!
+       void* fHostLockedMemory; //!
 
        int CUDASync(char* state = "UNKNOWN");
        template <class T> T* alignPointer(T* ptr, int alignment);
@@ -63,21 +72,21 @@ private:
        std::ostream* fOutFile;         //Debug Output Stream Pointer
        unsigned long long int fGPUMemSize;     //Memory Size to allocate on GPU
 
-       void* fpCudaStreams;
+       void* fpCudaStreams; //!
 
-       int fSliceCount;
+       int fSliceCount; //!
 
-       static const int fgkNSlices = 36;
-       AliHLTTPCCATracker fSlaveTrackers[fgkNSlices];
+       static const int fgkNSlices = 36; //!
+       AliHLTTPCCATracker fSlaveTrackers[fgkNSlices]; //!
 #ifdef HLTCA_GPUCODE
        bool CudaFailedMsg(cudaError_t error);
 #endif //HLTCA_GPUCODE
 
        AliHLTTPCCASliceOutput::outputControlStruct* fOutputControl;
        
-       static bool fgGPUUsed;
-       int fThreadId;
-       int fCudaInitialized;
+       static bool fgGPUUsed; //!
+       int fThreadId; //!
+       int fCudaInitialized; //!
 
        // disable copy
        AliHLTTPCCAGPUTrackerNVCC( const AliHLTTPCCAGPUTrackerNVCC& );