xref: /petsc/src/sys/classes/draw/utils/hists.c (revision 5b399a637f946da949d4901b9cfb4dd7404a5662)
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*/
6af0996ceSBarry Smith #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 
37*5b399a63SLisandro Dalcin    Collective on 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   PetscBool      isnull;
56e118a51fSLisandro Dalcin   PetscDrawHG    h;
575c6c1daeSBarry Smith   PetscErrorCode ierr;
585c6c1daeSBarry Smith 
595c6c1daeSBarry Smith   PetscFunctionBegin;
605c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID,1);
61e118a51fSLisandro Dalcin   PetscValidLogicalCollectiveInt(draw,bins,2);
625c6c1daeSBarry Smith   PetscValidPointer(hist,3);
63e118a51fSLisandro Dalcin   ierr = PetscDrawIsNull(draw,&isnull);CHKERRQ(ierr);
64e118a51fSLisandro Dalcin   if (isnull) {*hist = NULL; PetscFunctionReturn(0);}
65e118a51fSLisandro Dalcin 
6673107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(h, PETSC_DRAWHG_CLASSID,  "PetscDrawHG", "Histogram", "Draw", PetscObjectComm((PetscObject)draw), PetscDrawHGDestroy, NULL);CHKERRQ(ierr);
67e118a51fSLisandro Dalcin   ierr = PetscLogObjectParent((PetscObject)draw,(PetscObject)h);CHKERRQ(ierr);
68e118a51fSLisandro Dalcin 
69e118a51fSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)draw);CHKERRQ(ierr);
70e118a51fSLisandro Dalcin   h->win = draw;
71a297a907SKarl Rupp 
720298fd71SBarry Smith   h->view        = NULL;
730298fd71SBarry Smith   h->destroy     = NULL;
745c6c1daeSBarry Smith   h->color       = PETSC_DRAW_GREEN;
755c6c1daeSBarry Smith   h->xmin        = PETSC_MAX_REAL;
765c6c1daeSBarry Smith   h->xmax        = PETSC_MIN_REAL;
775c6c1daeSBarry Smith   h->ymin        = 0.;
785c6c1daeSBarry Smith   h->ymax        = 1.;
795c6c1daeSBarry Smith   h->numBins     = bins;
805c6c1daeSBarry Smith   h->maxBins     = bins;
81a297a907SKarl Rupp 
82785e854fSJed Brown   ierr = PetscMalloc1(h->maxBins,&h->bins);CHKERRQ(ierr);
83a297a907SKarl Rupp 
845c6c1daeSBarry Smith   h->numValues   = 0;
855c6c1daeSBarry Smith   h->maxValues   = CHUNKSIZE;
865c6c1daeSBarry Smith   h->calcStats   = PETSC_FALSE;
875c6c1daeSBarry Smith   h->integerBins = PETSC_FALSE;
88a297a907SKarl Rupp 
89785e854fSJed Brown   ierr = PetscMalloc1(h->maxValues,&h->values);CHKERRQ(ierr);
903bb1ff40SBarry Smith   ierr = PetscLogObjectMemory((PetscObject)h,(h->maxBins + h->maxValues)*sizeof(PetscReal));CHKERRQ(ierr);
91a297a907SKarl Rupp 
925c6c1daeSBarry Smith   ierr = PetscDrawAxisCreate(draw,&h->axis);CHKERRQ(ierr);
933bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)h,(PetscObject)h->axis);CHKERRQ(ierr);
94e118a51fSLisandro Dalcin 
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 
104*5b399a63SLisandro Dalcin    Logically Collective on PetscDrawHG
1055c6c1daeSBarry Smith 
1065c6c1daeSBarry Smith    Input Parameter:
1075c6c1daeSBarry Smith +  hist - The histogram context.
108e118a51fSLisandro Dalcin -  bins  - The number of bins.
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;
120e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
1215c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
122e118a51fSLisandro Dalcin   PetscValidLogicalCollectiveInt(hist,bins,2);
123e118a51fSLisandro Dalcin 
1245c6c1daeSBarry Smith   if (hist->maxBins < bins) {
1255c6c1daeSBarry Smith     ierr = PetscFree(hist->bins);CHKERRQ(ierr);
126785e854fSJed Brown     ierr = PetscMalloc1(bins, &hist->bins);CHKERRQ(ierr);
1273bb1ff40SBarry Smith     ierr = PetscLogObjectMemory((PetscObject)hist, (bins - hist->maxBins) * sizeof(PetscReal));CHKERRQ(ierr);
1285c6c1daeSBarry Smith     hist->maxBins = bins;
1295c6c1daeSBarry Smith   }
1305c6c1daeSBarry Smith   hist->numBins = bins;
1315c6c1daeSBarry Smith   PetscFunctionReturn(0);
1325c6c1daeSBarry Smith }
1335c6c1daeSBarry Smith 
1345c6c1daeSBarry Smith #undef __FUNCT__
1355c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGReset"
1365c6c1daeSBarry Smith /*@
1375c6c1daeSBarry Smith   PetscDrawHGReset - Clears histogram to allow for reuse with new data.
1385c6c1daeSBarry Smith 
139*5b399a63SLisandro Dalcin   Logically Collective on PetscDrawHG
1405c6c1daeSBarry Smith 
1415c6c1daeSBarry Smith   Input Parameter:
1425c6c1daeSBarry Smith . hist - The histogram context.
1435c6c1daeSBarry Smith 
1445c6c1daeSBarry Smith   Level: intermediate
1455c6c1daeSBarry Smith 
1465c6c1daeSBarry Smith   Concepts: histogram^resetting
1475c6c1daeSBarry Smith @*/
1485c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGReset(PetscDrawHG hist)
1495c6c1daeSBarry Smith {
1505c6c1daeSBarry Smith   PetscFunctionBegin;
151e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
1525c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
153e118a51fSLisandro Dalcin 
1545c6c1daeSBarry Smith   hist->xmin      = PETSC_MAX_REAL;
1555c6c1daeSBarry Smith   hist->xmax      = PETSC_MIN_REAL;
1565c6c1daeSBarry Smith   hist->ymin      = 0.0;
1575c6c1daeSBarry Smith   hist->ymax      = 0.0;
1585c6c1daeSBarry Smith   hist->numValues = 0;
1595c6c1daeSBarry Smith   PetscFunctionReturn(0);
1605c6c1daeSBarry Smith }
1615c6c1daeSBarry Smith 
1625c6c1daeSBarry Smith #undef __FUNCT__
1635c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGDestroy"
1645c6c1daeSBarry Smith /*@C
1655c6c1daeSBarry Smith   PetscDrawHGDestroy - Frees all space taken up by histogram data structure.
1665c6c1daeSBarry Smith 
167*5b399a63SLisandro Dalcin   Collective on PetscDrawHG
1685c6c1daeSBarry Smith 
1695c6c1daeSBarry Smith   Input Parameter:
1705c6c1daeSBarry Smith . hist - The histogram context
1715c6c1daeSBarry Smith 
1725c6c1daeSBarry Smith   Level: intermediate
1735c6c1daeSBarry Smith 
1745c6c1daeSBarry Smith .seealso:  PetscDrawHGCreate()
1755c6c1daeSBarry Smith @*/
1765c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGDestroy(PetscDrawHG *hist)
1775c6c1daeSBarry Smith {
1785c6c1daeSBarry Smith   PetscErrorCode ierr;
1795c6c1daeSBarry Smith 
1805c6c1daeSBarry Smith   PetscFunctionBegin;
1815c6c1daeSBarry Smith   if (!*hist) PetscFunctionReturn(0);
182e118a51fSLisandro Dalcin   PetscValidHeaderSpecific(*hist,PETSC_DRAWHG_CLASSID,1);
183e118a51fSLisandro Dalcin   if (--((PetscObject)(*hist))->refct > 0) {*hist = NULL; PetscFunctionReturn(0);}
1845c6c1daeSBarry Smith 
1855c6c1daeSBarry Smith   ierr = PetscFree((*hist)->bins);CHKERRQ(ierr);
1865c6c1daeSBarry Smith   ierr = PetscFree((*hist)->values);CHKERRQ(ierr);
187e118a51fSLisandro Dalcin   ierr = PetscDrawAxisDestroy(&(*hist)->axis);CHKERRQ(ierr);
188e118a51fSLisandro Dalcin   ierr = PetscDrawDestroy(&(*hist)->win);CHKERRQ(ierr);
1895c6c1daeSBarry Smith   ierr = PetscHeaderDestroy(hist);CHKERRQ(ierr);
1905c6c1daeSBarry Smith   PetscFunctionReturn(0);
1915c6c1daeSBarry Smith }
1925c6c1daeSBarry Smith 
1935c6c1daeSBarry Smith #undef __FUNCT__
1945c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGAddValue"
1955c6c1daeSBarry Smith /*@
1965c6c1daeSBarry Smith   PetscDrawHGAddValue - Adds another value to the histogram.
1975c6c1daeSBarry Smith 
198*5b399a63SLisandro Dalcin   Logically Collective on PetscDrawHG
1995c6c1daeSBarry Smith 
2005c6c1daeSBarry Smith   Input Parameters:
2015c6c1daeSBarry Smith + hist  - The histogram
2025c6c1daeSBarry Smith - value - The value
2035c6c1daeSBarry Smith 
2045c6c1daeSBarry Smith   Level: intermediate
2055c6c1daeSBarry Smith 
2065c6c1daeSBarry Smith   Concepts: histogram^adding values
2075c6c1daeSBarry Smith 
2085c6c1daeSBarry Smith .seealso: PetscDrawHGAddValues()
2095c6c1daeSBarry Smith @*/
2105c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGAddValue(PetscDrawHG hist, PetscReal value)
2115c6c1daeSBarry Smith {
2125c6c1daeSBarry Smith   PetscFunctionBegin;
213e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
2145c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
215e118a51fSLisandro Dalcin 
2165c6c1daeSBarry Smith   /* Allocate more memory if necessary */
2175c6c1daeSBarry Smith   if (hist->numValues >= hist->maxValues) {
2185c6c1daeSBarry Smith     PetscReal      *tmp;
2195c6c1daeSBarry Smith     PetscErrorCode ierr;
2205c6c1daeSBarry Smith 
221854ce69bSBarry Smith     ierr = PetscMalloc1(hist->maxValues+CHUNKSIZE, &tmp);CHKERRQ(ierr);
2223bb1ff40SBarry Smith     ierr = PetscLogObjectMemory((PetscObject)hist, CHUNKSIZE * sizeof(PetscReal));CHKERRQ(ierr);
2235c6c1daeSBarry Smith     ierr = PetscMemcpy(tmp, hist->values, hist->maxValues * sizeof(PetscReal));CHKERRQ(ierr);
2245c6c1daeSBarry Smith     ierr = PetscFree(hist->values);CHKERRQ(ierr);
225a297a907SKarl Rupp 
2265c6c1daeSBarry Smith     hist->values     = tmp;
2275c6c1daeSBarry Smith     hist->maxValues += CHUNKSIZE;
2285c6c1daeSBarry Smith   }
2295c6c1daeSBarry Smith   /* I disagree with the original Petsc implementation here. There should be no overshoot, but rather the
2305c6c1daeSBarry Smith      stated convention of using half-open intervals (always the way to go) */
2315c6c1daeSBarry Smith   if (!hist->numValues) {
2325c6c1daeSBarry Smith     hist->xmin = value;
2335c6c1daeSBarry Smith     hist->xmax = value;
2345c6c1daeSBarry Smith #if 1
2355c6c1daeSBarry Smith   } else {
2365c6c1daeSBarry Smith     /* Update limits */
237a297a907SKarl Rupp     if (value > hist->xmax) hist->xmax = value;
238a297a907SKarl Rupp     if (value < hist->xmin) hist->xmin = value;
2395c6c1daeSBarry Smith #else
2405c6c1daeSBarry Smith   } else if (hist->numValues == 1) {
2415c6c1daeSBarry Smith     /* Update limits -- We need to overshoot the largest value somewhat */
242a297a907SKarl Rupp     if (value > hist->xmax) hist->xmax = value + 0.001*(value - hist->xmin)/hist->numBins;
2435c6c1daeSBarry Smith     if (value < hist->xmin) {
2445c6c1daeSBarry Smith       hist->xmin = value;
2455c6c1daeSBarry Smith       hist->xmax = hist->xmax + 0.001*(hist->xmax - hist->xmin)/hist->numBins;
2465c6c1daeSBarry Smith     }
2475c6c1daeSBarry Smith   } else {
2485c6c1daeSBarry Smith     /* Update limits -- We need to overshoot the largest value somewhat */
249a297a907SKarl Rupp     if (value > hist->xmax) hist->xmax = value + 0.001*(hist->xmax - hist->xmin)/hist->numBins;
250a297a907SKarl Rupp     if (value < hist->xmin) hist->xmin = value;
2515c6c1daeSBarry Smith #endif
2525c6c1daeSBarry Smith   }
2535c6c1daeSBarry Smith 
2545c6c1daeSBarry Smith   hist->values[hist->numValues++] = value;
2555c6c1daeSBarry Smith   PetscFunctionReturn(0);
2565c6c1daeSBarry Smith }
2575c6c1daeSBarry Smith 
2585c6c1daeSBarry Smith #undef __FUNCT__
2595c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGDraw"
2605c6c1daeSBarry Smith /*@
2615c6c1daeSBarry Smith   PetscDrawHGDraw - Redraws a histogram.
2625c6c1daeSBarry Smith 
263*5b399a63SLisandro Dalcin   Collective on PetscDrawHG
2645c6c1daeSBarry Smith 
2655c6c1daeSBarry Smith   Input Parameter:
2665c6c1daeSBarry Smith . hist - The histogram context
2675c6c1daeSBarry Smith 
2685c6c1daeSBarry Smith   Level: intermediate
2695c6c1daeSBarry Smith 
2705c6c1daeSBarry Smith @*/
2715c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGDraw(PetscDrawHG hist)
2725c6c1daeSBarry Smith {
273e118a51fSLisandro Dalcin   PetscDraw      draw;
2745c6c1daeSBarry Smith   PetscBool      isnull;
2755c6c1daeSBarry Smith   PetscReal      xmin,xmax,ymin,ymax,*bins,*values,binSize,binLeft,binRight,maxHeight,mean,var;
2765c6c1daeSBarry Smith   char           title[256];
2775c6c1daeSBarry Smith   char           xlabel[256];
2785c6c1daeSBarry Smith   PetscInt       numBins,numBinsOld,numValues,initSize,i,p,bcolor,color;
279e118a51fSLisandro Dalcin   PetscMPIInt    rank;
2805c6c1daeSBarry Smith   PetscErrorCode ierr;
2815c6c1daeSBarry Smith 
2825c6c1daeSBarry Smith   PetscFunctionBegin;
283e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
2845c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
2858f69470aSLisandro Dalcin   ierr = PetscDrawIsNull(hist->win,&isnull);CHKERRQ(ierr);
2868f69470aSLisandro Dalcin   if (isnull) PetscFunctionReturn(0);
287*5b399a63SLisandro Dalcin   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)hist),&rank);CHKERRQ(ierr);
288e118a51fSLisandro Dalcin 
2895c6c1daeSBarry Smith   if ((hist->xmin >= hist->xmax) || (hist->ymin >= hist->ymax)) PetscFunctionReturn(0);
2905c6c1daeSBarry Smith   if (hist->numValues < 1) PetscFunctionReturn(0);
2915c6c1daeSBarry Smith 
2925c6c1daeSBarry Smith   color = hist->color;
293a297a907SKarl Rupp   if (color == PETSC_DRAW_ROTATE) bcolor = 2;
294a297a907SKarl Rupp   else bcolor = color;
295a297a907SKarl Rupp 
2965c6c1daeSBarry Smith   xmin      = hist->xmin;
2975c6c1daeSBarry Smith   xmax      = hist->xmax;
2985c6c1daeSBarry Smith   ymin      = hist->ymin;
2995c6c1daeSBarry Smith   ymax      = hist->ymax;
3005c6c1daeSBarry Smith   numValues = hist->numValues;
3015c6c1daeSBarry Smith   values    = hist->values;
3025c6c1daeSBarry Smith   mean      = 0.0;
3035c6c1daeSBarry Smith   var       = 0.0;
3045c6c1daeSBarry Smith 
305*5b399a63SLisandro Dalcin   draw = hist->win;
306e118a51fSLisandro Dalcin   ierr = PetscDrawCheckResizedWindow(draw);CHKERRQ(ierr);
307*5b399a63SLisandro Dalcin   ierr = PetscDrawClear(draw);CHKERRQ(ierr);
308e118a51fSLisandro Dalcin 
3095c6c1daeSBarry Smith   if (xmin == xmax) {
3105c6c1daeSBarry Smith     /* Calculate number of points in each bin */
3115c6c1daeSBarry Smith     bins    = hist->bins;
3125c6c1daeSBarry Smith     bins[0] = 0.;
3135c6c1daeSBarry Smith     for (p = 0; p < numValues; p++) {
3145c6c1daeSBarry Smith       if (values[p] == xmin) bins[0]++;
3155c6c1daeSBarry Smith       mean += values[p];
3165c6c1daeSBarry Smith       var  += values[p]*values[p];
3175c6c1daeSBarry Smith     }
3185c6c1daeSBarry Smith     maxHeight = bins[0];
3195c6c1daeSBarry Smith     if (maxHeight > ymax) ymax = hist->ymax = maxHeight;
3205c6c1daeSBarry Smith     xmax = xmin + 1;
3215c6c1daeSBarry Smith     ierr = PetscDrawAxisSetLimits(hist->axis, xmin, xmax, ymin, ymax);CHKERRQ(ierr);
3225c6c1daeSBarry Smith     if (hist->calcStats) {
3235c6c1daeSBarry Smith       mean /= numValues;
324a297a907SKarl Rupp       if (numValues > 1) var = (var - numValues*mean*mean) / (numValues-1);
325a297a907SKarl Rupp       else var = 0.0;
3265c6c1daeSBarry Smith       ierr = PetscSNPrintf(title, 256, "Mean: %g  Var: %g", (double)mean, (double)var);CHKERRQ(ierr);
3275c6c1daeSBarry Smith       ierr = PetscSNPrintf(xlabel,256, "Total: %D", numValues);CHKERRQ(ierr);
3280298fd71SBarry Smith       ierr = PetscDrawAxisSetLabels(hist->axis, title, xlabel, NULL);CHKERRQ(ierr);
3295c6c1daeSBarry Smith     }
3305c6c1daeSBarry Smith     ierr = PetscDrawAxisDraw(hist->axis);CHKERRQ(ierr);
331*5b399a63SLisandro Dalcin     ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
332e118a51fSLisandro Dalcin     if (!rank) { /* Draw bins */
3335c6c1daeSBarry Smith       binLeft  = xmin;
3345c6c1daeSBarry Smith       binRight = xmax;
3355c6c1daeSBarry Smith       ierr = PetscDrawRectangle(draw,binLeft,ymin,binRight,bins[0],bcolor,bcolor,bcolor,bcolor);CHKERRQ(ierr);
3365c6c1daeSBarry Smith       ierr = PetscDrawLine(draw,binLeft,ymin,binLeft,bins[0],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3375c6c1daeSBarry Smith       ierr = PetscDrawLine(draw,binRight,ymin,binRight,bins[0],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3385c6c1daeSBarry Smith       ierr = PetscDrawLine(draw,binLeft,bins[0],binRight,bins[0],PETSC_DRAW_BLACK);CHKERRQ(ierr);
339e118a51fSLisandro Dalcin       if (color == PETSC_DRAW_ROTATE && bins[0] != 0.0) bcolor++;
340e118a51fSLisandro Dalcin       if (bcolor > PETSC_DRAW_BASIC_COLORS-1) bcolor = 2;
341e118a51fSLisandro Dalcin     }
342*5b399a63SLisandro Dalcin     ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
3435c6c1daeSBarry Smith   } else {
3445c6c1daeSBarry Smith     numBins    = hist->numBins;
3455c6c1daeSBarry Smith     numBinsOld = hist->numBins;
3465c6c1daeSBarry Smith     if (hist->integerBins && (((int) xmax - xmin) + 1.0e-05 > xmax - xmin)) {
3475c6c1daeSBarry Smith       initSize = (int) ((int) xmax - xmin)/numBins;
3485c6c1daeSBarry Smith       while (initSize*numBins != (int) xmax - xmin) {
3495c6c1daeSBarry Smith         initSize = PetscMax(initSize - 1, 1);
3505c6c1daeSBarry Smith         numBins  = (int) ((int) xmax - xmin)/initSize;
3515c6c1daeSBarry Smith         ierr     = PetscDrawHGSetNumberBins(hist, numBins);CHKERRQ(ierr);
3525c6c1daeSBarry Smith       }
3535c6c1daeSBarry Smith     }
3545c6c1daeSBarry Smith     binSize = (xmax - xmin)/numBins;
3555c6c1daeSBarry Smith     bins    = hist->bins;
3565c6c1daeSBarry Smith 
3575c6c1daeSBarry Smith     ierr = PetscMemzero(bins, numBins * sizeof(PetscReal));CHKERRQ(ierr);
358a297a907SKarl Rupp 
3595c6c1daeSBarry Smith     maxHeight = 0.0;
3605c6c1daeSBarry Smith     for (i = 0; i < numBins; i++) {
3615c6c1daeSBarry Smith       binLeft  = xmin + binSize*i;
3625c6c1daeSBarry Smith       binRight = xmin + binSize*(i+1);
3635c6c1daeSBarry Smith       for (p = 0; p < numValues; p++) {
3645c6c1daeSBarry Smith         if ((values[p] >= binLeft) && (values[p] < binRight)) bins[i]++;
3655c6c1daeSBarry Smith         /* Handle last bin separately */
3665c6c1daeSBarry Smith         if ((i == numBins-1) && (values[p] == binRight)) bins[i]++;
3675c6c1daeSBarry Smith         if (!i) {
3685c6c1daeSBarry Smith           mean += values[p];
3695c6c1daeSBarry Smith           var  += values[p]*values[p];
3705c6c1daeSBarry Smith         }
3715c6c1daeSBarry Smith       }
3725c6c1daeSBarry Smith       maxHeight = PetscMax(maxHeight, bins[i]);
3735c6c1daeSBarry Smith     }
3745c6c1daeSBarry Smith     if (maxHeight > ymax) ymax = hist->ymax = maxHeight;
3755c6c1daeSBarry Smith 
3765c6c1daeSBarry Smith     ierr = PetscDrawAxisSetLimits(hist->axis, xmin, xmax, ymin, ymax);CHKERRQ(ierr);
3775c6c1daeSBarry Smith     if (hist->calcStats) {
3785c6c1daeSBarry Smith       mean /= numValues;
379a297a907SKarl Rupp       if (numValues > 1) var = (var - numValues*mean*mean) / (numValues-1);
380a297a907SKarl Rupp       else var = 0.0;
3815c6c1daeSBarry Smith       ierr = PetscSNPrintf(title, 256,"Mean: %g  Var: %g", (double)mean, (double)var);CHKERRQ(ierr);
3825c6c1daeSBarry Smith       ierr = PetscSNPrintf(xlabel,256, "Total: %D", numValues);CHKERRQ(ierr);
3830298fd71SBarry Smith       ierr = PetscDrawAxisSetLabels(hist->axis, title, xlabel, NULL);CHKERRQ(ierr);
3845c6c1daeSBarry Smith     }
3855c6c1daeSBarry Smith     ierr = PetscDrawAxisDraw(hist->axis);CHKERRQ(ierr);
386*5b399a63SLisandro Dalcin     ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
387e118a51fSLisandro Dalcin     if (!rank) { /* Draw bins */
3885c6c1daeSBarry Smith       for (i = 0; i < numBins; i++) {
3895c6c1daeSBarry Smith         binLeft  = xmin + binSize*i;
3905c6c1daeSBarry Smith         binRight = xmin + binSize*(i+1);
3915c6c1daeSBarry Smith         ierr = PetscDrawRectangle(draw,binLeft,ymin,binRight,bins[i],bcolor,bcolor,bcolor,bcolor);CHKERRQ(ierr);
3925c6c1daeSBarry Smith         ierr = PetscDrawLine(draw,binLeft,ymin,binLeft,bins[i],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3935c6c1daeSBarry Smith         ierr = PetscDrawLine(draw,binRight,ymin,binRight,bins[i],PETSC_DRAW_BLACK);CHKERRQ(ierr);
3945c6c1daeSBarry Smith         ierr = PetscDrawLine(draw,binLeft,bins[i],binRight,bins[i],PETSC_DRAW_BLACK);CHKERRQ(ierr);
395e118a51fSLisandro Dalcin         if (color == PETSC_DRAW_ROTATE && bins[i]) bcolor++;
396e118a51fSLisandro Dalcin         if (bcolor > PETSC_DRAW_BASIC_COLORS-1) bcolor = 2;
397e118a51fSLisandro Dalcin       }
3985c6c1daeSBarry Smith     }
399*5b399a63SLisandro Dalcin     ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
4005c6c1daeSBarry Smith     ierr = PetscDrawHGSetNumberBins(hist,numBinsOld);CHKERRQ(ierr);
4015c6c1daeSBarry Smith   }
402e118a51fSLisandro Dalcin 
403*5b399a63SLisandro Dalcin   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4045c6c1daeSBarry Smith   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
4055c6c1daeSBarry Smith   PetscFunctionReturn(0);
4065c6c1daeSBarry Smith }
4075c6c1daeSBarry Smith 
4085c6c1daeSBarry Smith #undef __FUNCT__
40934a5a0e3SBarry Smith #define __FUNCT__ "PetscDrawHGView"
4105c6c1daeSBarry Smith /*@
41134a5a0e3SBarry Smith   PetscDrawHGView - Prints the histogram information.
4125c6c1daeSBarry Smith 
4135c6c1daeSBarry Smith   Not collective
4145c6c1daeSBarry Smith 
4155c6c1daeSBarry Smith   Input Parameter:
4165c6c1daeSBarry Smith . hist - The histogram context
4175c6c1daeSBarry Smith 
4185c6c1daeSBarry Smith   Level: beginner
4195c6c1daeSBarry Smith 
4205c6c1daeSBarry Smith .keywords:  draw, histogram
4215c6c1daeSBarry Smith @*/
42234a5a0e3SBarry Smith PetscErrorCode  PetscDrawHGView(PetscDrawHG hist,PetscViewer viewer)
4235c6c1daeSBarry Smith {
4245c6c1daeSBarry Smith   PetscReal      xmax,xmin,*bins,*values,binSize,binLeft,binRight,mean,var;
4255c6c1daeSBarry Smith   PetscErrorCode ierr;
4265c6c1daeSBarry Smith   PetscInt       numBins,numBinsOld,numValues,initSize,i,p;
4275c6c1daeSBarry Smith 
4285c6c1daeSBarry Smith   PetscFunctionBegin;
429e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
4305c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
431e118a51fSLisandro Dalcin 
4325c6c1daeSBarry Smith   if ((hist->xmin > hist->xmax) || (hist->ymin >= hist->ymax)) PetscFunctionReturn(0);
4335c6c1daeSBarry Smith   if (hist->numValues < 1) PetscFunctionReturn(0);
4345c6c1daeSBarry Smith 
43534a5a0e3SBarry Smith   if (!viewer){
43634a5a0e3SBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)hist),&viewer);CHKERRQ(ierr);
43734a5a0e3SBarry Smith   }
43898c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)hist,viewer);CHKERRQ(ierr);
4395c6c1daeSBarry Smith   xmax      = hist->xmax;
4405c6c1daeSBarry Smith   xmin      = hist->xmin;
4415c6c1daeSBarry Smith   numValues = hist->numValues;
4425c6c1daeSBarry Smith   values    = hist->values;
4435c6c1daeSBarry Smith   mean      = 0.0;
4445c6c1daeSBarry Smith   var       = 0.0;
4455c6c1daeSBarry Smith   if (xmax == xmin) {
4465c6c1daeSBarry Smith     /* Calculate number of points in the bin */
4475c6c1daeSBarry Smith     bins    = hist->bins;
4485c6c1daeSBarry Smith     bins[0] = 0.;
4495c6c1daeSBarry Smith     for (p = 0; p < numValues; p++) {
4505c6c1daeSBarry Smith       if (values[p] == xmin) bins[0]++;
4515c6c1daeSBarry Smith       mean += values[p];
4525c6c1daeSBarry Smith       var  += values[p]*values[p];
4535c6c1daeSBarry Smith     }
4545c6c1daeSBarry Smith     /* Draw bins */
45534a5a0e3SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer, "Bin %2d (%6.2g - %6.2g): %.0g\n", 0, (double)xmin, (double)xmax, (double)bins[0]);CHKERRQ(ierr);
4565c6c1daeSBarry Smith   } else {
4575c6c1daeSBarry Smith     numBins    = hist->numBins;
4585c6c1daeSBarry Smith     numBinsOld = hist->numBins;
4595c6c1daeSBarry Smith     if (hist->integerBins && (((int) xmax - xmin) + 1.0e-05 > xmax - xmin)) {
4605c6c1daeSBarry Smith       initSize = (int) ((int) xmax - xmin)/numBins;
4615c6c1daeSBarry Smith       while (initSize*numBins != (int) xmax - xmin) {
4625c6c1daeSBarry Smith         initSize = PetscMax(initSize - 1, 1);
4635c6c1daeSBarry Smith         numBins  = (int) ((int) xmax - xmin)/initSize;
4645c6c1daeSBarry Smith         ierr     = PetscDrawHGSetNumberBins(hist, numBins);CHKERRQ(ierr);
4655c6c1daeSBarry Smith       }
4665c6c1daeSBarry Smith     }
4675c6c1daeSBarry Smith     binSize = (xmax - xmin)/numBins;
4685c6c1daeSBarry Smith     bins    = hist->bins;
4695c6c1daeSBarry Smith 
4705c6c1daeSBarry Smith     /* Calculate number of points in each bin */
4715c6c1daeSBarry Smith     ierr = PetscMemzero(bins, numBins * sizeof(PetscReal));CHKERRQ(ierr);
4725c6c1daeSBarry Smith     for (i = 0; i < numBins; i++) {
4735c6c1daeSBarry Smith       binLeft  = xmin + binSize*i;
4745c6c1daeSBarry Smith       binRight = xmin + binSize*(i+1);
4755c6c1daeSBarry Smith       for (p = 0; p < numValues; p++) {
4765c6c1daeSBarry Smith         if ((values[p] >= binLeft) && (values[p] < binRight)) bins[i]++;
4775c6c1daeSBarry Smith         /* Handle last bin separately */
4785c6c1daeSBarry Smith         if ((i == numBins-1) && (values[p] == binRight)) bins[i]++;
4795c6c1daeSBarry Smith         if (!i) {
4805c6c1daeSBarry Smith           mean += values[p];
4815c6c1daeSBarry Smith           var  += values[p]*values[p];
4825c6c1daeSBarry Smith         }
4835c6c1daeSBarry Smith       }
4845c6c1daeSBarry Smith     }
4855c6c1daeSBarry Smith     /* Draw bins */
4865c6c1daeSBarry Smith     for (i = 0; i < numBins; i++) {
4875c6c1daeSBarry Smith       binLeft  = xmin + binSize*i;
4885c6c1daeSBarry Smith       binRight = xmin + binSize*(i+1);
48934a5a0e3SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer, "Bin %2d (%6.2g - %6.2g): %.0g\n", (int)i, (double)binLeft, (double)binRight, (double)bins[i]);CHKERRQ(ierr);
4905c6c1daeSBarry Smith     }
4915c6c1daeSBarry Smith     ierr = PetscDrawHGSetNumberBins(hist, numBinsOld);CHKERRQ(ierr);
4925c6c1daeSBarry Smith   }
4935c6c1daeSBarry Smith 
4945c6c1daeSBarry Smith   if (hist->calcStats) {
4955c6c1daeSBarry Smith     mean /= numValues;
496a297a907SKarl Rupp     if (numValues > 1) var = (var - numValues*mean*mean) / (numValues-1);
497a297a907SKarl Rupp     else var = 0.0;
49857622a8eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer, "Mean: %g  Var: %g\n", (double)mean, (double)var);CHKERRQ(ierr);
49934a5a0e3SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer, "Total: %D\n", numValues);CHKERRQ(ierr);
5005c6c1daeSBarry Smith   }
5015c6c1daeSBarry Smith   PetscFunctionReturn(0);
5025c6c1daeSBarry Smith }
5035c6c1daeSBarry Smith 
5045c6c1daeSBarry Smith #undef __FUNCT__
5055c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGSetColor"
5065c6c1daeSBarry Smith /*@
5075c6c1daeSBarry Smith   PetscDrawHGSetColor - Sets the color the bars will be drawn with.
5085c6c1daeSBarry Smith 
509*5b399a63SLisandro Dalcin   Logically Collective on PetscDrawHG
5105c6c1daeSBarry Smith 
5115c6c1daeSBarry Smith   Input Parameters:
5125c6c1daeSBarry Smith + hist - The histogram context
5135c6c1daeSBarry Smith - color - one of the colors defined in petscdraw.h or PETSC_DRAW_ROTATE to make each bar a
5145c6c1daeSBarry Smith           different color
5155c6c1daeSBarry Smith 
5165c6c1daeSBarry Smith   Level: intermediate
5175c6c1daeSBarry Smith 
5185c6c1daeSBarry Smith @*/
5195c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGSetColor(PetscDrawHG hist,int color)
5205c6c1daeSBarry Smith {
5215c6c1daeSBarry Smith   PetscFunctionBegin;
522e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
5235c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
524e118a51fSLisandro Dalcin 
5255c6c1daeSBarry Smith   hist->color = color;
5265c6c1daeSBarry Smith   PetscFunctionReturn(0);
5275c6c1daeSBarry Smith }
5285c6c1daeSBarry Smith 
5295c6c1daeSBarry Smith #undef __FUNCT__
5305c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGSetLimits"
5315c6c1daeSBarry Smith /*@
5325c6c1daeSBarry Smith   PetscDrawHGSetLimits - Sets the axis limits for a histogram. If more
5335c6c1daeSBarry Smith   points are added after this call, the limits will be adjusted to
5345c6c1daeSBarry Smith   include those additional points.
5355c6c1daeSBarry Smith 
536*5b399a63SLisandro Dalcin   Logically Collective on PetscDrawHG
5375c6c1daeSBarry Smith 
5385c6c1daeSBarry Smith   Input Parameters:
5395c6c1daeSBarry Smith + hist - The histogram context
5405c6c1daeSBarry Smith - x_min,x_max,y_min,y_max - The limits
5415c6c1daeSBarry Smith 
5425c6c1daeSBarry Smith   Level: intermediate
5435c6c1daeSBarry Smith 
5445c6c1daeSBarry Smith   Concepts: histogram^setting axis
5455c6c1daeSBarry Smith @*/
5465c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGSetLimits(PetscDrawHG hist, PetscReal x_min, PetscReal x_max, int y_min, int y_max)
5475c6c1daeSBarry Smith {
5485c6c1daeSBarry Smith   PetscFunctionBegin;
549e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
5505c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
551e118a51fSLisandro Dalcin 
5525c6c1daeSBarry Smith   hist->xmin = x_min;
5535c6c1daeSBarry Smith   hist->xmax = x_max;
5545c6c1daeSBarry Smith   hist->ymin = y_min;
5555c6c1daeSBarry Smith   hist->ymax = y_max;
5565c6c1daeSBarry Smith   PetscFunctionReturn(0);
5575c6c1daeSBarry Smith }
5585c6c1daeSBarry Smith 
5595c6c1daeSBarry Smith #undef __FUNCT__
5605c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGCalcStats"
5615c6c1daeSBarry Smith /*@
5625c6c1daeSBarry Smith   PetscDrawHGCalcStats - Turns on calculation of descriptive statistics
5635c6c1daeSBarry Smith 
5645c6c1daeSBarry Smith   Not collective
5655c6c1daeSBarry Smith 
5665c6c1daeSBarry Smith   Input Parameters:
5675c6c1daeSBarry Smith + hist - The histogram context
5685c6c1daeSBarry Smith - calc - Flag for calculation
5695c6c1daeSBarry Smith 
5705c6c1daeSBarry Smith   Level: intermediate
5715c6c1daeSBarry Smith 
5725c6c1daeSBarry Smith .keywords:  draw, histogram, statistics
5735c6c1daeSBarry Smith 
5745c6c1daeSBarry Smith @*/
5755c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGCalcStats(PetscDrawHG hist, PetscBool calc)
5765c6c1daeSBarry Smith {
5775c6c1daeSBarry Smith   PetscFunctionBegin;
578e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
5795c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
580e118a51fSLisandro Dalcin 
5815c6c1daeSBarry Smith   hist->calcStats = calc;
5825c6c1daeSBarry Smith   PetscFunctionReturn(0);
5835c6c1daeSBarry Smith }
5845c6c1daeSBarry Smith 
5855c6c1daeSBarry Smith #undef __FUNCT__
5865c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGIntegerBins"
5875c6c1daeSBarry Smith /*@
5885c6c1daeSBarry Smith   PetscDrawHGIntegerBins - Turns on integer width bins
5895c6c1daeSBarry Smith 
5905c6c1daeSBarry Smith   Not collective
5915c6c1daeSBarry Smith 
5925c6c1daeSBarry Smith   Input Parameters:
5935c6c1daeSBarry Smith + hist - The histogram context
5945c6c1daeSBarry Smith - ints - Flag for integer width bins
5955c6c1daeSBarry Smith 
5965c6c1daeSBarry Smith   Level: intermediate
5975c6c1daeSBarry Smith 
5985c6c1daeSBarry Smith .keywords:  draw, histogram, statistics
5995c6c1daeSBarry Smith @*/
6005c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGIntegerBins(PetscDrawHG hist, PetscBool ints)
6015c6c1daeSBarry Smith {
6025c6c1daeSBarry Smith   PetscFunctionBegin;
603e118a51fSLisandro Dalcin   if (!hist) PetscFunctionReturn(0);
6045c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
605e118a51fSLisandro Dalcin 
6065c6c1daeSBarry Smith   hist->integerBins = ints;
6075c6c1daeSBarry Smith   PetscFunctionReturn(0);
6085c6c1daeSBarry Smith }
6095c6c1daeSBarry Smith 
6105c6c1daeSBarry Smith #undef __FUNCT__
6115c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGGetAxis"
6125c6c1daeSBarry Smith /*@C
6135c6c1daeSBarry Smith   PetscDrawHGGetAxis - Gets the axis context associated with a histogram.
6145c6c1daeSBarry Smith   This is useful if one wants to change some axis property, such as
6155c6c1daeSBarry Smith   labels, color, etc. The axis context should not be destroyed by the
6165c6c1daeSBarry Smith   application code.
6175c6c1daeSBarry Smith 
618*5b399a63SLisandro Dalcin   Not Collective, PetscDrawAxis is parallel if PetscDrawHG is parallel
6195c6c1daeSBarry Smith 
6205c6c1daeSBarry Smith   Input Parameter:
6215c6c1daeSBarry Smith . hist - The histogram context
6225c6c1daeSBarry Smith 
6235c6c1daeSBarry Smith   Output Parameter:
6245c6c1daeSBarry Smith . axis - The axis context
6255c6c1daeSBarry Smith 
6265c6c1daeSBarry Smith   Level: intermediate
6275c6c1daeSBarry Smith 
6285c6c1daeSBarry Smith @*/
6295c6c1daeSBarry Smith PetscErrorCode  PetscDrawHGGetAxis(PetscDrawHG hist, PetscDrawAxis *axis)
6305c6c1daeSBarry Smith {
6315c6c1daeSBarry Smith   PetscFunctionBegin;
6325c6c1daeSBarry Smith   PetscValidPointer(axis,2);
633e118a51fSLisandro Dalcin   if (!hist) {*axis = NULL; PetscFunctionReturn(0);}
634e118a51fSLisandro Dalcin   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
635e118a51fSLisandro Dalcin 
6365c6c1daeSBarry Smith   *axis = hist->axis;
6375c6c1daeSBarry Smith   PetscFunctionReturn(0);
6385c6c1daeSBarry Smith }
6395c6c1daeSBarry Smith 
6405c6c1daeSBarry Smith #undef __FUNCT__
6415c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawHGGetDraw"
6425c6c1daeSBarry Smith /*@C
6435c6c1daeSBarry Smith   PetscDrawHGGetDraw - Gets the draw context associated with a histogram.
6445c6c1daeSBarry Smith 
6455c6c1daeSBarry Smith   Not Collective, PetscDraw is parallel if PetscDrawHG is parallel
6465c6c1daeSBarry Smith 
6475c6c1daeSBarry Smith   Input Parameter:
6485c6c1daeSBarry Smith . hist - The histogram context
6495c6c1daeSBarry Smith 
6505c6c1daeSBarry Smith   Output Parameter:
651e118a51fSLisandro Dalcin . draw  - The draw context
6525c6c1daeSBarry Smith 
6535c6c1daeSBarry Smith   Level: intermediate
6545c6c1daeSBarry Smith 
6555c6c1daeSBarry Smith @*/
656e118a51fSLisandro Dalcin PetscErrorCode  PetscDrawHGGetDraw(PetscDrawHG hist, PetscDraw *draw)
6575c6c1daeSBarry Smith {
6585c6c1daeSBarry Smith   PetscFunctionBegin;
659e118a51fSLisandro Dalcin   PetscValidPointer(draw,2);
660e118a51fSLisandro Dalcin   if (!hist) {*draw = NULL; PetscFunctionReturn(0);}
6615c6c1daeSBarry Smith   PetscValidHeaderSpecific(hist,PETSC_DRAWHG_CLASSID,1);
662e118a51fSLisandro Dalcin 
663e118a51fSLisandro Dalcin   *draw = hist->win;
6645c6c1daeSBarry Smith   PetscFunctionReturn(0);
6655c6c1daeSBarry Smith }
6665c6c1daeSBarry Smith 
667