Changeset 896abb3 in sasview for pr_inversion/c_extensions/invertor.h

Timestamp:

May 23, 2008 2:31:50 PM (16 years ago)

Author:

Mathieu Doucet <doucetm@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

ffca8f2

Parents:

a1718df

Message:

Added docs

File:

• pr_inversion/c_extensions/invertor.h (modified) (1 diff)

pr_inversion/c_extensions/invertor.h

@@ -2 +2 @@
 #define invertor_h
 
-
+/**
+ * Internal data structure for P(r) inversion
+ */
 typedef struct {
+        /// Maximum distance between any two points in the system
     double d_max;
+    /// q data
     double *x;
+    /// I(q) data
     double *y;
+    /// dI(q) data
     double *err;
+    /// Number of q points
     int npoints;    
+    /// Number of I(q) points
     int ny;    
+    /// Number of dI(q) points
     int nerr;  
+    /// Alpha value
     double alpha;
+    /// Minimum q to include in inversion
     double q_min;
+    /// Maximum q to include in inversion
     double q_max;
 } Invertor_params;