xref: /petsc/src/sys/classes/draw/utils/hists.c (revision 785e854f82a3c614b452fca2cf5ad4f2afe8bdde)
15c6c1daeSBarry Smith 
25c6c1daeSBarry Smith /*
35c6c1daeSBarry Smith   Contains the data structure for plotting a histogram in a window with an axis.
45c6c1daeSBarry Smith */
59804daf3SBarry Smith #include <petscdraw.h>         /*I "petscdraw.h" I*/
6afcb2eb5SJed Brown #include <petsc-private/petscimpl.h>         /*I "petscsys.h" I*/
734a5a0e3SBarry Smith #include <petscviewer.h>         /*I "petscviewer.h" I*/
85c6c1daeSBarry Smith 
95c6c1daeSBarry Smith PetscClassId PETSC_DRAWHG_CLASSID = 0;
105c6c1daeSBarry Smith 
115c6c1daeSBarry Smith struct _p_PetscDrawHG {
125c6c1daeSBarry Smith   PETSCHEADER(int);
135c6c1daeSBarry Smith   PetscErrorCode (*destroy)(PetscDrawSP);
145c6c1daeSBarry Smith   PetscErrorCode (*view)(PetscDrawSP,PetscViewer);
155c6c1daeSBarry Smith   PetscDraw      win;
165c6c1daeSBarry Smith   PetscDrawAxis  axis;
175c6c1daeSBarry Smith   PetscReal      xmin,xmax;
185c6c1daeSBarry Smith   PetscReal      ymin,ymax;
195c6c1daeSBarry Smith   int            numBins;
205c6c1daeSBarry Smith   int            maxBins;
215c6c1daeSBarry Smith   PetscReal      *bins;
225c6c1daeSBarry Smith   int            numValues;
235c6c1daeSBarry Smith   int            maxValues;
245c6c1daeSBarry Smith   PetscReal      *values;
255c6c1daeSBarry Smith   int            color;
265c6c1daeSBarry Smith   PetscBool      calcStats;
275c6c1daeSBarry Smith   PetscBool      integerBins;
285c6c1daeSBarry Smith };
295c6c1daeSBarry Smith 
305c6c1daeSBarry Smith #define CHUNKSIZE 100
315c6c1daeSBarry Smith 
325c6c1daeSBarry Smith #undef __FUNCT__
335c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGCreate"
345c6c1daeSBarry Smith /*@C
355c6c1daeSBarry Smith    PetscDrawHGCreate - Creates a histogram data structure.
365c6c1daeSBarry Smith 
375c6c1daeSBarry Smith    Collective over PetscDraw
385c6c1daeSBarry Smith 
395c6c1daeSBarry Smith    Input Parameters:
405c6c1daeSBarry Smith +  draw  - The window where the graph will be made
415c6c1daeSBarry Smith -  bins - The number of bins to use
425c6c1daeSBarry Smith 
435c6c1daeSBarry Smith    Output Parameters:
445c6c1daeSBarry Smith .  hist - The histogram context
455c6c1daeSBarry Smith 
465c6c1daeSBarry Smith    Level: intermediate
475c6c1daeSBarry Smith 
485c6c1daeSBarry Smith    Concepts: histogram^creating
495c6c1daeSBarry Smith 
505c6c1daeSBarry Smith .seealso: PetscDrawHGDestroy()
515c6c1daeSBarry Smith 
525c6c1daeSBarry Smith @*/
530adebc6cSBarry Smith PetscErrorCode  PetscDrawHGCreate(PetscDraw draw, int bins, PetscDrawHG *hist)
540adebc6cSBarry Smith {
555c6c1daeSBarry Smith   PetscDrawHG    h;
565c6c1daeSBarry Smith   MPI_Comm       comm;
575c6c1daeSBarry Smith   PetscBool      isnull;
585c6c1daeSBarry Smith   PetscErrorCode ierr;
595c6c1daeSBarry Smith 
605c6c1daeSBarry Smith   PetscFunctionBegin;
615c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID,1);
625c6c1daeSBarry Smith   PetscValidPointer(hist,3);
635c6c1daeSBarry Smith   ierr = PetscObjectGetComm((PetscObject) draw, &comm);CHKERRQ(ierr);
6467c2884eSBarry Smith   ierr = PetscHeaderCreate(h, _p_PetscDrawHG, int, PETSC_DRAWHG_CLASSID,  "PetscDrawHG", "Histogram", "Draw", comm, PetscDrawHGDestroy, NULL);CHKERRQ(ierr);
65a297a907SKarl Rupp 
660298fd71SBarry Smith   h->view        = NULL;
670298fd71SBarry Smith   h->destroy     = NULL;
685c6c1daeSBarry Smith   h->win         = draw;
69a297a907SKarl Rupp 
705c6c1daeSBarry Smith   ierr = PetscObjectReference((PetscObject) draw);CHKERRQ(ierr);
71a297a907SKarl Rupp 
725c6c1daeSBarry Smith   h->color       = PETSC_DRAW_GREEN;
735c6c1daeSBarry Smith   h->xmin        = PETSC_MAX_REAL;
745c6c1daeSBarry Smith   h->xmax        = PETSC_MIN_REAL;
755c6c1daeSBarry Smith   h->ymin        = 0.;
765c6c1daeSBarry Smith   h->ymax        = 1.;
775c6c1daeSBarry Smith   h->numBins     = bins;
785c6c1daeSBarry Smith   h->maxBins     = bins;
79a297a907SKarl Rupp 
80*785e854fSJed Brown   ierr = PetscMalloc1(h->maxBins, &h->bins);CHKERRQ(ierr);
81a297a907SKarl Rupp 
825c6c1daeSBarry Smith   h->numValues   = 0;
835c6c1daeSBarry Smith   h->maxValues   = CHUNKSIZE;
845c6c1daeSBarry Smith   h->calcStats   = PETSC_FALSE;
855c6c1daeSBarry Smith   h->integerBins = PETSC_FALSE;
86a297a907SKarl Rupp 
87*785e854fSJed Brown   ierr = PetscMalloc1(h->maxValues, &h->values);CHKERRQ(ierr);
883bb1ff40SBarry Smith   ierr = PetscLogObjectMemory((PetscObject)h, (h->maxBins + h->maxValues)*sizeof(PetscReal));CHKERRQ(ierr);
895c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject) draw, PETSC_DRAW_NULL, &isnull);CHKERRQ(ierr);
90a297a907SKarl Rupp 
915c6c1daeSBarry Smith   if (!isnull) {
925c6c1daeSBarry Smith     ierr = PetscDrawAxisCreate(draw, &h->axis);CHKERRQ(ierr);
933bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)h, (PetscObject)h->axis);CHKERRQ(ierr);
940298fd71SBarry Smith   } else h->axis = NULL;
955c6c1daeSBarry Smith   *hist = h;
965c6c1daeSBarry Smith   PetscFunctionReturn(0);
975c6c1daeSBarry Smith }
985c6c1daeSBarry Smith 
995c6c1daeSBarry Smith #undef __FUNCT__
1005c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGSetNumberBins"
1015c6c1daeSBarry Smith /*@
1025c6c1daeSBarry Smith    PetscDrawHGSetNumberBins - Change the number of bins that are to be drawn.
1035c6c1daeSBarry Smith 
1045c6c1daeSBarry Smith    Not Collective (ignored except on processor 0 of PetscDrawHG)
1055c6c1daeSBarry Smith 
1065c6c1daeSBarry Smith    Input Parameter:
1075c6c1daeSBarry Smith +  hist - The histogram context.
1085c6c1daeSBarry Smith -  dim  - The number of curves.
1095c6c1daeSBarry Smith 
1105c6c1daeSBarry Smith    Level: intermediate
1115c6c1daeSBarry Smith 
1125c6c1daeSBarry Smith    Concepts: histogram^setting number of bins
1135c6c1daeSBarry Smith 
1145c6c1daeSBarry Smith @*/
1155c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGSetNumberBins(PetscDrawHG hist, int bins)
1165c6c1daeSBarry Smith {
1175c6c1daeSBarry Smith   PetscErrorCode ierr;
1185c6c1daeSBarry Smith 
1195c6c1daeSBarry Smith   PetscFunctionBegin;
1205c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
1215c6c1daeSBarry Smith   if (hist->maxBins < bins) {
1225c6c1daeSBarry Smith     ierr = PetscFree(hist->bins);CHKERRQ(ierr);
123*785e854fSJed Brown     ierr = PetscMalloc1(bins, &hist->bins);CHKERRQ(ierr);
1243bb1ff40SBarry Smith     ierr = PetscLogObjectMemory((PetscObject)hist, (bins - hist->maxBins) * sizeof(PetscReal));CHKERRQ(ierr);
125a297a907SKarl Rupp 
1265c6c1daeSBarry Smith     hist->maxBins = bins;
1275c6c1daeSBarry Smith   }
1285c6c1daeSBarry Smith   hist->numBins = bins;
1295c6c1daeSBarry Smith   PetscFunctionReturn(0);
1305c6c1daeSBarry Smith }
1315c6c1daeSBarry Smith 
1325c6c1daeSBarry Smith #undef __FUNCT__
1335c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGReset"
1345c6c1daeSBarry Smith /*@
1355c6c1daeSBarry Smith   PetscDrawHGReset - Clears histogram to allow for reuse with new data.
1365c6c1daeSBarry Smith 
1375c6c1daeSBarry Smith   Not Collective (ignored except on processor 0 of PetscDrawHG)
1385c6c1daeSBarry Smith 
1395c6c1daeSBarry Smith   Input Parameter:
1405c6c1daeSBarry Smith . hist - The histogram context.
1415c6c1daeSBarry Smith 
1425c6c1daeSBarry Smith   Level: intermediate
1435c6c1daeSBarry Smith 
1445c6c1daeSBarry Smith   Concepts: histogram^resetting
1455c6c1daeSBarry Smith @*/
1465c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGReset(PetscDrawHG hist)
1475c6c1daeSBarry Smith {
1485c6c1daeSBarry Smith   PetscFunctionBegin;
1495c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
1505c6c1daeSBarry Smith   hist->xmin      = PETSC_MAX_REAL;
1515c6c1daeSBarry Smith   hist->xmax      = PETSC_MIN_REAL;
1525c6c1daeSBarry Smith   hist->ymin      = 0.0;
1535c6c1daeSBarry Smith   hist->ymax      = 0.0;
1545c6c1daeSBarry Smith   hist->numValues = 0;
1555c6c1daeSBarry Smith   PetscFunctionReturn(0);
1565c6c1daeSBarry Smith }
1575c6c1daeSBarry Smith 
1585c6c1daeSBarry Smith #undef __FUNCT__
1595c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGDestroy"
1605c6c1daeSBarry Smith /*@C
1615c6c1daeSBarry Smith   PetscDrawHGDestroy - Frees all space taken up by histogram data structure.
1625c6c1daeSBarry Smith 
1635c6c1daeSBarry Smith   Collective over PetscDrawHG
1645c6c1daeSBarry Smith 
1655c6c1daeSBarry Smith   Input Parameter:
1665c6c1daeSBarry Smith . hist - The histogram context
1675c6c1daeSBarry Smith 
1685c6c1daeSBarry Smith   Level: intermediate
1695c6c1daeSBarry Smith 
1705c6c1daeSBarry Smith .seealso:  PetscDrawHGCreate()
1715c6c1daeSBarry Smith @*/
1725c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGDestroy(PetscDrawHG *hist)
1735c6c1daeSBarry Smith {
1745c6c1daeSBarry Smith   PetscErrorCode ierr;
1755c6c1daeSBarry Smith 
1765c6c1daeSBarry Smith   PetscFunctionBegin;
1775c6c1daeSBarry Smith   if (!*hist) PetscFunctionReturn(0);
1785c6c1daeSBarry Smith   PetscValidHeader(*hist,1);
1795c6c1daeSBarry Smith 
1805c6c1daeSBarry Smith   if (--((PetscObject)(*hist))->refct > 0) PetscFunctionReturn(0);
1815c6c1daeSBarry Smith   ierr = PetscDrawAxisDestroy(&(*hist)->axis);CHKERRQ(ierr);
1825c6c1daeSBarry Smith   ierr = PetscDrawDestroy(&(*hist)->win);CHKERRQ(ierr);
1835c6c1daeSBarry Smith   ierr = PetscFree((*hist)->bins);CHKERRQ(ierr);
1845c6c1daeSBarry Smith   ierr = PetscFree((*hist)->values);CHKERRQ(ierr);
1855c6c1daeSBarry Smith   ierr = PetscHeaderDestroy(hist);CHKERRQ(ierr);
1865c6c1daeSBarry Smith   PetscFunctionReturn(0);
1875c6c1daeSBarry Smith }
1885c6c1daeSBarry Smith 
1895c6c1daeSBarry Smith #undef __FUNCT__
1905c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGAddValue"
1915c6c1daeSBarry Smith /*@
1925c6c1daeSBarry Smith   PetscDrawHGAddValue - Adds another value to the histogram.
1935c6c1daeSBarry Smith 
1945c6c1daeSBarry Smith   Not Collective (ignored except on processor 0 of PetscDrawHG)
1955c6c1daeSBarry Smith 
1965c6c1daeSBarry Smith   Input Parameters:
1975c6c1daeSBarry Smith + hist  - The histogram
1985c6c1daeSBarry Smith - value - The value
1995c6c1daeSBarry Smith 
2005c6c1daeSBarry Smith   Level: intermediate
2015c6c1daeSBarry Smith 
2025c6c1daeSBarry Smith   Concepts: histogram^adding values
2035c6c1daeSBarry Smith 
2045c6c1daeSBarry Smith .seealso: PetscDrawHGAddValues()
2055c6c1daeSBarry Smith @*/
2065c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGAddValue(PetscDrawHG hist, PetscReal value)
2075c6c1daeSBarry Smith {
2085c6c1daeSBarry Smith   PetscFunctionBegin;
2095c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
2105c6c1daeSBarry Smith   /* Allocate more memory if necessary */
2115c6c1daeSBarry Smith   if (hist->numValues >= hist->maxValues) {
2125c6c1daeSBarry Smith     PetscReal      *tmp;
2135c6c1daeSBarry Smith     PetscErrorCode ierr;
2145c6c1daeSBarry Smith 
215*785e854fSJed Brown     ierr = PetscMalloc1((hist->maxValues+CHUNKSIZE), &tmp);CHKERRQ(ierr);
2163bb1ff40SBarry Smith     ierr = PetscLogObjectMemory((PetscObject)hist, CHUNKSIZE * sizeof(PetscReal));CHKERRQ(ierr);
2175c6c1daeSBarry Smith     ierr = PetscMemcpy(tmp, hist->values, hist->maxValues * sizeof(PetscReal));CHKERRQ(ierr);
2185c6c1daeSBarry Smith     ierr = PetscFree(hist->values);CHKERRQ(ierr);
219a297a907SKarl Rupp 
2205c6c1daeSBarry Smith     hist->values     = tmp;
2215c6c1daeSBarry Smith     hist->maxValues += CHUNKSIZE;
2225c6c1daeSBarry Smith   }
2235c6c1daeSBarry Smith   /* I disagree with the original Petsc implementation here. There should be no overshoot, but rather the
2245c6c1daeSBarry Smith      stated convention of using half-open intervals (always the way to go) */
2255c6c1daeSBarry Smith   if (!hist->numValues) {
2265c6c1daeSBarry Smith     hist->xmin = value;
2275c6c1daeSBarry Smith     hist->xmax = value;
2285c6c1daeSBarry Smith #if 1
2295c6c1daeSBarry Smith   } else {
2305c6c1daeSBarry Smith     /* Update limits */
231a297a907SKarl Rupp     if (value > hist->xmax) hist->xmax = value;
232a297a907SKarl Rupp     if (value < hist->xmin) hist->xmin = value;
2335c6c1daeSBarry Smith #else
2345c6c1daeSBarry Smith   } else if (hist->numValues == 1) {
2355c6c1daeSBarry Smith     /* Update limits -- We need to overshoot the largest value somewhat */
236a297a907SKarl Rupp     if (value > hist->xmax) hist->xmax = value + 0.001*(value - hist->xmin)/hist->numBins;
2375c6c1daeSBarry Smith     if (value < hist->xmin) {
2385c6c1daeSBarry Smith       hist->xmin = value;
2395c6c1daeSBarry Smith       hist->xmax = hist->xmax + 0.001*(hist->xmax - hist->xmin)/hist->numBins;
2405c6c1daeSBarry Smith     }
2415c6c1daeSBarry Smith   } else {
2425c6c1daeSBarry Smith     /* Update limits -- We need to overshoot the largest value somewhat */
243a297a907SKarl Rupp     if (value > hist->xmax) hist->xmax = value + 0.001*(hist->xmax - hist->xmin)/hist->numBins;
244a297a907SKarl Rupp     if (value < hist->xmin) hist->xmin = value;
2455c6c1daeSBarry Smith #endif
2465c6c1daeSBarry Smith   }
2475c6c1daeSBarry Smith 
2485c6c1daeSBarry Smith   hist->values[hist->numValues++] = value;
2495c6c1daeSBarry Smith   PetscFunctionReturn(0);
2505c6c1daeSBarry Smith }
2515c6c1daeSBarry Smith 
2525c6c1daeSBarry Smith #undef __FUNCT__
2535c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGDraw"
2545c6c1daeSBarry Smith /*@
2555c6c1daeSBarry Smith   PetscDrawHGDraw - Redraws a histogram.
2565c6c1daeSBarry Smith 
2575c6c1daeSBarry Smith   Not Collective (ignored except on processor 0 of PetscDrawHG)
2585c6c1daeSBarry Smith 
2595c6c1daeSBarry Smith   Input Parameter:
2605c6c1daeSBarry Smith . hist - The histogram context
2615c6c1daeSBarry Smith 
2625c6c1daeSBarry Smith   Level: intermediate
2635c6c1daeSBarry Smith 
2645c6c1daeSBarry Smith @*/
2655c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGDraw(PetscDrawHG hist)
2665c6c1daeSBarry Smith {
2675c6c1daeSBarry Smith   PetscDraw      draw = hist->win;
2685c6c1daeSBarry Smith   PetscBool      isnull;
2695c6c1daeSBarry Smith   PetscReal      xmin,xmax,ymin,ymax,*bins,*values,binSize,binLeft,binRight,maxHeight,mean,var;
2705c6c1daeSBarry Smith   char           title[256];
2715c6c1daeSBarry Smith   char           xlabel[256];
2725c6c1daeSBarry Smith   PetscInt       numBins,numBinsOld,numValues,initSize,i,p,bcolor,color;
2735c6c1daeSBarry Smith   PetscErrorCode ierr;
2745c6c1daeSBarry Smith 
2755c6c1daeSBarry Smith   PetscFunctionBegin;
2765c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
2775c6c1daeSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject) draw, PETSC_DRAW_NULL, &isnull);CHKERRQ(ierr);
2785c6c1daeSBarry Smith   if (isnull) PetscFunctionReturn(0);
2795c6c1daeSBarry Smith   if ((hist->xmin >= hist->xmax) || (hist->ymin >= hist->ymax)) PetscFunctionReturn(0);
2805c6c1daeSBarry Smith   if (hist->numValues < 1) PetscFunctionReturn(0);
2815c6c1daeSBarry Smith 
2825c6c1daeSBarry Smith #if 0
283ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)hist),&rank);CHKERRQ(ierr);
2845c6c1daeSBarry Smith   if (rank) PetscFunctionReturn(0);
2855c6c1daeSBarry Smith #endif
2865c6c1daeSBarry Smith 
2875c6c1daeSBarry Smith   color = hist->color;
288a297a907SKarl Rupp   if (color == PETSC_DRAW_ROTATE) bcolor = 2;
289a297a907SKarl Rupp   else bcolor = color;
290a297a907SKarl Rupp 
2915c6c1daeSBarry Smith   xmin      = hist->xmin;
2925c6c1daeSBarry Smith   xmax      = hist->xmax;
2935c6c1daeSBarry Smith   ymin      = hist->ymin;
2945c6c1daeSBarry Smith   ymax      = hist->ymax;
2955c6c1daeSBarry Smith   numValues = hist->numValues;
2965c6c1daeSBarry Smith   values    = hist->values;
2975c6c1daeSBarry Smith   mean      = 0.0;
2985c6c1daeSBarry Smith   var       = 0.0;
2995c6c1daeSBarry Smith 
3005c6c1daeSBarry Smith   ierr = PetscDrawClear(draw);CHKERRQ(ierr);
3015c6c1daeSBarry Smith   if (xmin == xmax) {
3025c6c1daeSBarry Smith     /* Calculate number of points in each bin */
3035c6c1daeSBarry Smith     bins    = hist->bins;
3045c6c1daeSBarry Smith     bins[0] = 0.;
3055c6c1daeSBarry Smith     for (p = 0; p < numValues; p++) {
3065c6c1daeSBarry Smith       if (values[p] == xmin) bins[0]++;
3075c6c1daeSBarry Smith       mean += values[p];
3085c6c1daeSBarry Smith       var  += values[p]*values[p];
3095c6c1daeSBarry Smith     }
3105c6c1daeSBarry Smith     maxHeight = bins[0];
3115c6c1daeSBarry Smith     if (maxHeight > ymax) ymax = hist->ymax = maxHeight;
3125c6c1daeSBarry Smith     xmax = xmin + 1;
3135c6c1daeSBarry Smith     ierr = PetscDrawAxisSetLimits(hist->axis, xmin, xmax, ymin, ymax);CHKERRQ(ierr);
3145c6c1daeSBarry Smith     if (hist->calcStats) {
3155c6c1daeSBarry Smith       mean /= numValues;
316a297a907SKarl Rupp       if (numValues > 1) var = (var - numValues*mean*mean) / (numValues-1);
317a297a907SKarl Rupp       else var = 0.0;
3185c6c1daeSBarry Smith       ierr = PetscSNPrintf(title, 256, "Mean: %g  Var: %g", (double)mean, (double)var);CHKERRQ(ierr);
3195c6c1daeSBarry Smith       ierr = PetscSNPrintf(xlabel,256, "Total: %D", numValues);CHKERRQ(ierr);
3200298fd71SBarry Smith       ierr = PetscDrawAxisSetLabels(hist->axis, title, xlabel, NULL);CHKERRQ(ierr);
3215c6c1daeSBarry Smith     }
3225c6c1daeSBarry Smith     ierr = PetscDrawAxisDraw(hist->axis);CHKERRQ(ierr);
3235c6c1daeSBarry Smith     /* Draw bins */
3245c6c1daeSBarry Smith     binLeft  = xmin;
3255c6c1daeSBarry Smith     binRight = xmax;
3265c6c1daeSBarry Smith     ierr = PetscDrawRectangle(draw,binLeft,ymin,binRight,bins[0],bcolor,bcolor,bcolor,bcolor);CHKERRQ(ierr);
327a297a907SKarl Rupp 
328a297a907SKarl Rupp     if (color == PETSC_DRAW_ROTATE && bins[0] != 0.0) bcolor++;
329a297a907SKarl Rupp     if (bcolor > 31) bcolor = 2;
330a297a907SKarl Rupp 
3315c6c1daeSBarry Smith     ierr = PetscDrawLine(draw,binLeft,ymin,binLeft,bins[0],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3325c6c1daeSBarry Smith     ierr = PetscDrawLine(draw,binRight,ymin,binRight,bins[0],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3335c6c1daeSBarry Smith     ierr = PetscDrawLine(draw,binLeft,bins[0],binRight,bins[0],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3345c6c1daeSBarry Smith   } else {
3355c6c1daeSBarry Smith     numBins    = hist->numBins;
3365c6c1daeSBarry Smith     numBinsOld = hist->numBins;
3375c6c1daeSBarry Smith     if (hist->integerBins && (((int) xmax - xmin) + 1.0e-05 > xmax - xmin)) {
3385c6c1daeSBarry Smith       initSize = (int) ((int) xmax - xmin)/numBins;
3395c6c1daeSBarry Smith       while (initSize*numBins != (int) xmax - xmin) {
3405c6c1daeSBarry Smith         initSize = PetscMax(initSize - 1, 1);
3415c6c1daeSBarry Smith         numBins  = (int) ((int) xmax - xmin)/initSize;
3425c6c1daeSBarry Smith         ierr     = PetscDrawHGSetNumberBins(hist, numBins);CHKERRQ(ierr);
3435c6c1daeSBarry Smith       }
3445c6c1daeSBarry Smith     }
3455c6c1daeSBarry Smith     binSize = (xmax - xmin)/numBins;
3465c6c1daeSBarry Smith     bins    = hist->bins;
3475c6c1daeSBarry Smith 
3485c6c1daeSBarry Smith     ierr = PetscMemzero(bins, numBins * sizeof(PetscReal));CHKERRQ(ierr);
349a297a907SKarl Rupp 
3505c6c1daeSBarry Smith     maxHeight = 0.0;
3515c6c1daeSBarry Smith     for (i = 0; i < numBins; i++) {
3525c6c1daeSBarry Smith       binLeft  = xmin + binSize*i;
3535c6c1daeSBarry Smith       binRight = xmin + binSize*(i+1);
3545c6c1daeSBarry Smith       for (p = 0; p < numValues; p++) {
3555c6c1daeSBarry Smith         if ((values[p] >= binLeft) && (values[p] < binRight)) bins[i]++;
3565c6c1daeSBarry Smith         /* Handle last bin separately */
3575c6c1daeSBarry Smith         if ((i == numBins-1) && (values[p] == binRight)) bins[i]++;
3585c6c1daeSBarry Smith         if (!i) {
3595c6c1daeSBarry Smith           mean += values[p];
3605c6c1daeSBarry Smith           var  += values[p]*values[p];
3615c6c1daeSBarry Smith         }
3625c6c1daeSBarry Smith       }
3635c6c1daeSBarry Smith       maxHeight = PetscMax(maxHeight, bins[i]);
3645c6c1daeSBarry Smith     }
3655c6c1daeSBarry Smith     if (maxHeight > ymax) ymax = hist->ymax = maxHeight;
3665c6c1daeSBarry Smith 
3675c6c1daeSBarry Smith     ierr = PetscDrawAxisSetLimits(hist->axis, xmin, xmax, ymin, ymax);CHKERRQ(ierr);
3685c6c1daeSBarry Smith     if (hist->calcStats) {
3695c6c1daeSBarry Smith       mean /= numValues;
370a297a907SKarl Rupp       if (numValues > 1) var = (var - numValues*mean*mean) / (numValues-1);
371a297a907SKarl Rupp       else var = 0.0;
372a297a907SKarl Rupp 
3735c6c1daeSBarry Smith       ierr = PetscSNPrintf(title, 256,"Mean: %g  Var: %g", (double)mean, (double)var);CHKERRQ(ierr);
3745c6c1daeSBarry Smith       ierr = PetscSNPrintf(xlabel,256, "Total: %D", numValues);CHKERRQ(ierr);
3750298fd71SBarry Smith       ierr = PetscDrawAxisSetLabels(hist->axis, title, xlabel, NULL);CHKERRQ(ierr);
3765c6c1daeSBarry Smith     }
3775c6c1daeSBarry Smith     ierr = PetscDrawAxisDraw(hist->axis);CHKERRQ(ierr);
3785c6c1daeSBarry Smith     /* Draw bins */
3795c6c1daeSBarry Smith     for (i = 0; i < numBins; i++) {
3805c6c1daeSBarry Smith       binLeft  = xmin + binSize*i;
3815c6c1daeSBarry Smith       binRight = xmin + binSize*(i+1);
3825c6c1daeSBarry Smith       ierr = PetscDrawRectangle(draw,binLeft,ymin,binRight,bins[i],bcolor,bcolor,bcolor,bcolor);CHKERRQ(ierr);
383a297a907SKarl Rupp       if (color == PETSC_DRAW_ROTATE && bins[i]) bcolor++;
384a297a907SKarl Rupp       if (bcolor > 31) bcolor = 2;
3855c6c1daeSBarry Smith       ierr = PetscDrawLine(draw,binLeft,ymin,binLeft,bins[i],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3865c6c1daeSBarry Smith       ierr = PetscDrawLine(draw,binRight,ymin,binRight,bins[i],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3875c6c1daeSBarry Smith       ierr = PetscDrawLine(draw,binLeft,bins[i],binRight,bins[i],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3885c6c1daeSBarry Smith     }
3895c6c1daeSBarry Smith     ierr = PetscDrawHGSetNumberBins(hist, numBinsOld);CHKERRQ(ierr);
3905c6c1daeSBarry Smith   }
3915c6c1daeSBarry Smith   ierr = PetscDrawSynchronizedFlush(draw);CHKERRQ(ierr);
3925c6c1daeSBarry Smith   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
3935c6c1daeSBarry Smith   PetscFunctionReturn(0);
3945c6c1daeSBarry Smith }
3955c6c1daeSBarry Smith 
3965c6c1daeSBarry Smith #undef __FUNCT__
39734a5a0e3SBarry Smith #define __FUNCT__ "PetscDrawHGView"
3985c6c1daeSBarry Smith /*@
39934a5a0e3SBarry Smith   PetscDrawHGView - Prints the histogram information.
4005c6c1daeSBarry Smith 
4015c6c1daeSBarry Smith   Not collective
4025c6c1daeSBarry Smith 
4035c6c1daeSBarry Smith   Input Parameter:
4045c6c1daeSBarry Smith . hist - The histogram context
4055c6c1daeSBarry Smith 
4065c6c1daeSBarry Smith   Level: beginner
4075c6c1daeSBarry Smith 
4085c6c1daeSBarry Smith .keywords:  draw, histogram
4095c6c1daeSBarry Smith @*/
41034a5a0e3SBarry Smith PetscErrorCode  PetscDrawHGView(PetscDrawHG hist,PetscViewer viewer)
4115c6c1daeSBarry Smith {
4125c6c1daeSBarry Smith   PetscReal      xmax,xmin,*bins,*values,binSize,binLeft,binRight,mean,var;
4135c6c1daeSBarry Smith   PetscErrorCode ierr;
4145c6c1daeSBarry Smith   PetscInt       numBins,numBinsOld,numValues,initSize,i,p;
4155c6c1daeSBarry Smith 
4165c6c1daeSBarry Smith   PetscFunctionBegin;
4175c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
4185c6c1daeSBarry Smith   if ((hist->xmin > hist->xmax) || (hist->ymin >= hist->ymax)) PetscFunctionReturn(0);
4195c6c1daeSBarry Smith   if (hist->numValues < 1) PetscFunctionReturn(0);
4205c6c1daeSBarry Smith 
42134a5a0e3SBarry Smith   if (!viewer){
42234a5a0e3SBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)hist),&viewer);CHKERRQ(ierr);
42334a5a0e3SBarry Smith   }
4245c6c1daeSBarry Smith   xmax      = hist->xmax;
4255c6c1daeSBarry Smith   xmin      = hist->xmin;
4265c6c1daeSBarry Smith   numValues = hist->numValues;
4275c6c1daeSBarry Smith   values    = hist->values;
4285c6c1daeSBarry Smith   mean      = 0.0;
4295c6c1daeSBarry Smith   var       = 0.0;
4305c6c1daeSBarry Smith   if (xmax == xmin) {
4315c6c1daeSBarry Smith     /* Calculate number of points in the bin */
4325c6c1daeSBarry Smith     bins    = hist->bins;
4335c6c1daeSBarry Smith     bins[0] = 0.;
4345c6c1daeSBarry Smith     for (p = 0; p < numValues; p++) {
4355c6c1daeSBarry Smith       if (values[p] == xmin) bins[0]++;
4365c6c1daeSBarry Smith       mean += values[p];
4375c6c1daeSBarry Smith       var  += values[p]*values[p];
4385c6c1daeSBarry Smith     }
4395c6c1daeSBarry Smith     /* Draw bins */
44034a5a0e3SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer, "Bin %2d (%6.2g - %6.2g): %.0g\n", 0, (double)xmin, (double)xmax, (double)bins[0]);CHKERRQ(ierr);
4415c6c1daeSBarry Smith   } else {
4425c6c1daeSBarry Smith     numBins    = hist->numBins;
4435c6c1daeSBarry Smith     numBinsOld = hist->numBins;
4445c6c1daeSBarry Smith     if (hist->integerBins && (((int) xmax - xmin) + 1.0e-05 > xmax - xmin)) {
4455c6c1daeSBarry Smith       initSize = (int) ((int) xmax - xmin)/numBins;
4465c6c1daeSBarry Smith       while (initSize*numBins != (int) xmax - xmin) {
4475c6c1daeSBarry Smith         initSize = PetscMax(initSize - 1, 1);
4485c6c1daeSBarry Smith         numBins  = (int) ((int) xmax - xmin)/initSize;
4495c6c1daeSBarry Smith         ierr     = PetscDrawHGSetNumberBins(hist, numBins);CHKERRQ(ierr);
4505c6c1daeSBarry Smith       }
4515c6c1daeSBarry Smith     }
4525c6c1daeSBarry Smith     binSize = (xmax - xmin)/numBins;
4535c6c1daeSBarry Smith     bins    = hist->bins;
4545c6c1daeSBarry Smith 
4555c6c1daeSBarry Smith     /* Calculate number of points in each bin */
4565c6c1daeSBarry Smith     ierr = PetscMemzero(bins, numBins * sizeof(PetscReal));CHKERRQ(ierr);
4575c6c1daeSBarry Smith     for (i = 0; i < numBins; i++) {
4585c6c1daeSBarry Smith       binLeft  = xmin + binSize*i;
4595c6c1daeSBarry Smith       binRight = xmin + binSize*(i+1);
4605c6c1daeSBarry Smith       for (p = 0; p < numValues; p++) {
4615c6c1daeSBarry Smith         if ((values[p] >= binLeft) && (values[p] < binRight)) bins[i]++;
4625c6c1daeSBarry Smith         /* Handle last bin separately */
4635c6c1daeSBarry Smith         if ((i == numBins-1) && (values[p] == binRight)) bins[i]++;
4645c6c1daeSBarry Smith         if (!i) {
4655c6c1daeSBarry Smith           mean += values[p];
4665c6c1daeSBarry Smith           var  += values[p]*values[p];
4675c6c1daeSBarry Smith         }
4685c6c1daeSBarry Smith       }
4695c6c1daeSBarry Smith     }
4705c6c1daeSBarry Smith     /* Draw bins */
4715c6c1daeSBarry Smith     for (i = 0; i < numBins; i++) {
4725c6c1daeSBarry Smith       binLeft  = xmin + binSize*i;
4735c6c1daeSBarry Smith       binRight = xmin + binSize*(i+1);
47434a5a0e3SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer, "Bin %2d (%6.2g - %6.2g): %.0g\n", (int)i, (double)binLeft, (double)binRight, (double)bins[i]);CHKERRQ(ierr);
4755c6c1daeSBarry Smith     }
4765c6c1daeSBarry Smith     ierr = PetscDrawHGSetNumberBins(hist, numBinsOld);CHKERRQ(ierr);
4775c6c1daeSBarry Smith   }
4785c6c1daeSBarry Smith 
4795c6c1daeSBarry Smith   if (hist->calcStats) {
4805c6c1daeSBarry Smith     mean /= numValues;
481a297a907SKarl Rupp     if (numValues > 1) var = (var - numValues*mean*mean) / (numValues-1);
482a297a907SKarl Rupp     else var = 0.0;
48334a5a0e3SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer, "Mean: %G  Var: %G\n", (double)mean, (double)var);CHKERRQ(ierr);
48434a5a0e3SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer, "Total: %D\n", numValues);CHKERRQ(ierr);
4855c6c1daeSBarry Smith   }
4865c6c1daeSBarry Smith   PetscFunctionReturn(0);
4875c6c1daeSBarry Smith }
4885c6c1daeSBarry Smith 
4895c6c1daeSBarry Smith #undef __FUNCT__
4905c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGSetColor"
4915c6c1daeSBarry Smith /*@
4925c6c1daeSBarry Smith   PetscDrawHGSetColor - Sets the color the bars will be drawn with.
4935c6c1daeSBarry Smith 
4945c6c1daeSBarry Smith   Not Collective (ignored except on processor 0 of PetscDrawHG)
4955c6c1daeSBarry Smith 
4965c6c1daeSBarry Smith   Input Parameters:
4975c6c1daeSBarry Smith + hist - The histogram context
4985c6c1daeSBarry Smith - color - one of the colors defined in petscdraw.h or PETSC_DRAW_ROTATE to make each bar a
4995c6c1daeSBarry Smith           different color
5005c6c1daeSBarry Smith 
5015c6c1daeSBarry Smith   Level: intermediate
5025c6c1daeSBarry Smith 
5035c6c1daeSBarry Smith @*/
5045c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGSetColor(PetscDrawHG hist, int color)
5055c6c1daeSBarry Smith {
5065c6c1daeSBarry Smith   PetscFunctionBegin;
5075c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
5085c6c1daeSBarry Smith   hist->color = color;
5095c6c1daeSBarry Smith   PetscFunctionReturn(0);
5105c6c1daeSBarry Smith }
5115c6c1daeSBarry Smith 
5125c6c1daeSBarry Smith #undef __FUNCT__
5135c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGSetLimits"
5145c6c1daeSBarry Smith /*@
5155c6c1daeSBarry Smith   PetscDrawHGSetLimits - Sets the axis limits for a histogram. If more
5165c6c1daeSBarry Smith   points are added after this call, the limits will be adjusted to
5175c6c1daeSBarry Smith   include those additional points.
5185c6c1daeSBarry Smith 
5195c6c1daeSBarry Smith   Not Collective (ignored except on processor 0 of PetscDrawHG)
5205c6c1daeSBarry Smith 
5215c6c1daeSBarry Smith   Input Parameters:
5225c6c1daeSBarry Smith + hist - The histogram context
5235c6c1daeSBarry Smith - x_min,x_max,y_min,y_max - The limits
5245c6c1daeSBarry Smith 
5255c6c1daeSBarry Smith   Level: intermediate
5265c6c1daeSBarry Smith 
5275c6c1daeSBarry Smith   Concepts: histogram^setting axis
5285c6c1daeSBarry Smith @*/
5295c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGSetLimits(PetscDrawHG hist, PetscReal x_min, PetscReal x_max, int y_min, int y_max)
5305c6c1daeSBarry Smith {
5315c6c1daeSBarry Smith   PetscFunctionBegin;
5325c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
5335c6c1daeSBarry Smith   hist->xmin = x_min;
5345c6c1daeSBarry Smith   hist->xmax = x_max;
5355c6c1daeSBarry Smith   hist->ymin = y_min;
5365c6c1daeSBarry Smith   hist->ymax = y_max;
5375c6c1daeSBarry Smith   PetscFunctionReturn(0);
5385c6c1daeSBarry Smith }
5395c6c1daeSBarry Smith 
5405c6c1daeSBarry Smith #undef __FUNCT__
5415c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGCalcStats"
5425c6c1daeSBarry Smith /*@
5435c6c1daeSBarry Smith   PetscDrawHGCalcStats - Turns on calculation of descriptive statistics
5445c6c1daeSBarry Smith 
5455c6c1daeSBarry Smith   Not collective
5465c6c1daeSBarry Smith 
5475c6c1daeSBarry Smith   Input Parameters:
5485c6c1daeSBarry Smith + hist - The histogram context
5495c6c1daeSBarry Smith - calc - Flag for calculation
5505c6c1daeSBarry Smith 
5515c6c1daeSBarry Smith   Level: intermediate
5525c6c1daeSBarry Smith 
5535c6c1daeSBarry Smith .keywords:  draw, histogram, statistics
5545c6c1daeSBarry Smith 
5555c6c1daeSBarry Smith @*/
5565c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGCalcStats(PetscDrawHG hist, PetscBool calc)
5575c6c1daeSBarry Smith {
5585c6c1daeSBarry Smith   PetscFunctionBegin;
5595c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
5605c6c1daeSBarry Smith   hist->calcStats = calc;
5615c6c1daeSBarry Smith   PetscFunctionReturn(0);
5625c6c1daeSBarry Smith }
5635c6c1daeSBarry Smith 
5645c6c1daeSBarry Smith #undef __FUNCT__
5655c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGIntegerBins"
5665c6c1daeSBarry Smith /*@
5675c6c1daeSBarry Smith   PetscDrawHGIntegerBins - Turns on integer width bins
5685c6c1daeSBarry Smith 
5695c6c1daeSBarry Smith   Not collective
5705c6c1daeSBarry Smith 
5715c6c1daeSBarry Smith   Input Parameters:
5725c6c1daeSBarry Smith + hist - The histogram context
5735c6c1daeSBarry Smith - ints - Flag for integer width bins
5745c6c1daeSBarry Smith 
5755c6c1daeSBarry Smith   Level: intermediate
5765c6c1daeSBarry Smith 
5775c6c1daeSBarry Smith .keywords:  draw, histogram, statistics
5785c6c1daeSBarry Smith @*/
5795c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGIntegerBins(PetscDrawHG hist, PetscBool ints)
5805c6c1daeSBarry Smith {
5815c6c1daeSBarry Smith   PetscFunctionBegin;
5825c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
5835c6c1daeSBarry Smith   hist->integerBins = ints;
5845c6c1daeSBarry Smith   PetscFunctionReturn(0);
5855c6c1daeSBarry Smith }
5865c6c1daeSBarry Smith 
5875c6c1daeSBarry Smith #undef __FUNCT__
5885c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGGetAxis"
5895c6c1daeSBarry Smith /*@C
5905c6c1daeSBarry Smith   PetscDrawHGGetAxis - Gets the axis context associated with a histogram.
5915c6c1daeSBarry Smith   This is useful if one wants to change some axis property, such as
5925c6c1daeSBarry Smith   labels, color, etc. The axis context should not be destroyed by the
5935c6c1daeSBarry Smith   application code.
5945c6c1daeSBarry Smith 
5955c6c1daeSBarry Smith   Not Collective (ignored except on processor 0 of PetscDrawHG)
5965c6c1daeSBarry Smith 
5975c6c1daeSBarry Smith   Input Parameter:
5985c6c1daeSBarry Smith . hist - The histogram context
5995c6c1daeSBarry Smith 
6005c6c1daeSBarry Smith   Output Parameter:
6015c6c1daeSBarry Smith . axis - The axis context
6025c6c1daeSBarry Smith 
6035c6c1daeSBarry Smith   Level: intermediate
6045c6c1daeSBarry Smith 
6055c6c1daeSBarry Smith @*/
6065c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGGetAxis(PetscDrawHG hist, PetscDrawAxis *axis)
6075c6c1daeSBarry Smith {
6085c6c1daeSBarry Smith   PetscFunctionBegin;
6095c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
6105c6c1daeSBarry Smith   PetscValidPointer(axis,2);
6115c6c1daeSBarry Smith   *axis = hist->axis;
6125c6c1daeSBarry Smith   PetscFunctionReturn(0);
6135c6c1daeSBarry Smith }
6145c6c1daeSBarry Smith 
6155c6c1daeSBarry Smith #undef __FUNCT__
6165c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGGetDraw"
6175c6c1daeSBarry Smith /*@C
6185c6c1daeSBarry Smith   PetscDrawHGGetDraw - Gets the draw context associated with a histogram.
6195c6c1daeSBarry Smith 
6205c6c1daeSBarry Smith   Not Collective, PetscDraw is parallel if PetscDrawHG is parallel
6215c6c1daeSBarry Smith 
6225c6c1daeSBarry Smith   Input Parameter:
6235c6c1daeSBarry Smith . hist - The histogram context
6245c6c1daeSBarry Smith 
6255c6c1daeSBarry Smith   Output Parameter:
6265c6c1daeSBarry Smith . win  - The draw context
6275c6c1daeSBarry Smith 
6285c6c1daeSBarry Smith   Level: intermediate
6295c6c1daeSBarry Smith 
6305c6c1daeSBarry Smith @*/
6315c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGGetDraw(PetscDrawHG hist, PetscDraw *win)
6325c6c1daeSBarry Smith {
6335c6c1daeSBarry Smith   PetscFunctionBegin;
6345c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist, PETSC_DRAWHG_CLASSID,1);
6355c6c1daeSBarry Smith   PetscValidPointer(win,2);
6365c6c1daeSBarry Smith   *win = hist->win;
6375c6c1daeSBarry Smith   PetscFunctionReturn(0);
6385c6c1daeSBarry Smith }
6395c6c1daeSBarry Smith 
640