xref: /petsc/src/sys/classes/draw/utils/axisc.c (revision 6497c311e7b976d467be1503c1effce92a60525c)

#include <petsc/private/drawimpl.h> /*I   "petscdraw.h"  I*/

#define PETSC_DRAW_AXIS_MAX_SEGMENTS 20
PetscClassId PETSC_DRAWAXIS_CLASSID = 0;

/*@
  PetscDrawAxisCreate - Generate the axis data structure.

  Collective

  Input Parameter:
. draw - `PetscDraw` object where axis to be made

  Output Parameter:
. axis - the axis datastructure

  Note:
  The MPI communicator that owns the underlying draw object owns the `PetscDrawAxis` object, but calls to set `PetscDrawAxis` options are
  ignored by all processes except the first MPI rank in the communicator

  Level: advanced

.seealso: `PetscDrawLGCreate()`, `PetscDrawLG`, `PetscDrawSPCreate()`, `PetscDrawSP`, `PetscDrawHGCreate()`, `PetscDrawHG`, `PetscDrawBarCreate()`, `PetscDrawBar`, `PetscDrawLGGetAxis()`, `PetscDrawSPGetAxis()`,
          `PetscDrawHGGetAxis()`, `PetscDrawBarGetAxis()`, `PetscDrawAxis`, `PetscDrawAxisDestroy()`, `PetscDrawAxisSetColors()`, `PetscDrawAxisSetLabels()`, `PetscDrawAxisSetLimits()`, `PetscDrawAxisGetLimits()`, `PetscDrawAxisSetHoldLimits()`,
          `PetscDrawAxisDraw()`
@*/
PetscErrorCode PetscDrawAxisCreate(PetscDraw draw, PetscDrawAxis *axis)
{
  PetscDrawAxis ad;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscAssertPointer(axis, 2);

  PetscCall(PetscHeaderCreate(ad, PETSC_DRAWAXIS_CLASSID, "DrawAxis", "Draw Axis", "Draw", PetscObjectComm((PetscObject)draw), PetscDrawAxisDestroy, NULL));
  PetscCall(PetscObjectReference((PetscObject)draw));
  ad->win       = draw;
  ad->xticks    = PetscADefTicks;
  ad->yticks    = PetscADefTicks;
  ad->xlabelstr = PetscADefLabel;
  ad->ylabelstr = PetscADefLabel;
  ad->ac        = PETSC_DRAW_BLACK;
  ad->tc        = PETSC_DRAW_BLACK;
  ad->cc        = PETSC_DRAW_BLACK;
  ad->xlabel    = NULL;
  ad->ylabel    = NULL;
  ad->toplabel  = NULL;
  *axis         = ad;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawAxisDestroy - Frees the space used by an axis structure.

  Collective

  Input Parameter:
. axis - the axis context

  Level: advanced

.seealso: `PetscDraw`, `PetscDrawAxisCreate()`, `PetscDrawAxis`
@*/
PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis *axis)
{
  PetscFunctionBegin;
  if (!*axis) PetscFunctionReturn(PETSC_SUCCESS);
  PetscValidHeaderSpecific(*axis, PETSC_DRAWAXIS_CLASSID, 1);
  if (--((PetscObject)*axis)->refct > 0) {
    *axis = NULL;
    PetscFunctionReturn(PETSC_SUCCESS);
  }

  PetscCall(PetscFree((*axis)->toplabel));
  PetscCall(PetscFree((*axis)->xlabel));
  PetscCall(PetscFree((*axis)->ylabel));
  PetscCall(PetscDrawDestroy(&(*axis)->win));
  PetscCall(PetscHeaderDestroy(axis));
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawAxisSetColors -  Sets the colors to be used for the axis,
  tickmarks, and text.

  Logically Collective

  Input Parameters:
+ axis - the axis
. ac   - the color of the axis lines
. tc   - the color of the tick marks
- cc   - the color of the text strings

  Level: advanced

.seealso: `PetscDraw`, `PetscDrawAxisCreate()`, `PetscDrawAxis`, `PetscDrawAxisSetLabels()`, `PetscDrawAxisDraw()`, `PetscDrawAxisSetLimits()`
@*/
PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis axis, int ac, int tc, int cc)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(axis, PETSC_DRAWAXIS_CLASSID, 1);
  PetscValidLogicalCollectiveInt(axis, ac, 2);
  PetscValidLogicalCollectiveInt(axis, tc, 3);
  PetscValidLogicalCollectiveInt(axis, cc, 4);
  axis->ac = ac;
  axis->tc = tc;
  axis->cc = cc;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawAxisSetLabels -  Sets the x and y axis labels.

  Logically Collective

  Input Parameters:
+ axis   - the axis
. top    - the label at the top of the image
. xlabel - the x axis label
- ylabel - the y axis label

  Level: advanced

  Notes:
  Must be called before `PetscDrawAxisDraw()` or `PetscDrawLGDraw()`

  There should be no newlines in the arguments

.seealso: `PetscDraw`, `PetscDrawAxisCreate()`, `PetscDrawAxis`, `PetscDrawAxisSetColors()`, `PetscDrawAxisDraw()`, `PetscDrawAxisSetLimits()`
@*/
PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis axis, const char top[], const char xlabel[], const char ylabel[])
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(axis, PETSC_DRAWAXIS_CLASSID, 1);
  PetscCall(PetscFree(axis->xlabel));
  PetscCall(PetscFree(axis->ylabel));
  PetscCall(PetscFree(axis->toplabel));
  PetscCall(PetscStrallocpy(xlabel, &axis->xlabel));
  PetscCall(PetscStrallocpy(ylabel, &axis->ylabel));
  PetscCall(PetscStrallocpy(top, &axis->toplabel));
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawAxisSetLimits -  Sets the limits (in user coords) of the axis

  Logically Collective

  Input Parameters:
+ axis - the axis
. xmin - the lower x limit
. xmax - the upper x limit
. ymin - the lower y limit
- ymax - the upper y limit

  Options Database Key:
. -drawaxis_hold - hold the initial set of axis limits for future plotting

  Level: advanced

.seealso: `PetscDrawAxisSetHoldLimits()`, `PetscDrawAxisGetLimits()`, `PetscDrawAxisSetLabels()`, `PetscDrawAxisSetColors()`
@*/
PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis axis, PetscReal xmin, PetscReal xmax, PetscReal ymin, PetscReal ymax)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(axis, PETSC_DRAWAXIS_CLASSID, 1);
  if (axis->hold) PetscFunctionReturn(PETSC_SUCCESS);
  axis->xlow  = xmin;
  axis->xhigh = xmax;
  axis->ylow  = ymin;
  axis->yhigh = ymax;
  PetscCall(PetscOptionsHasName(((PetscObject)axis)->options, ((PetscObject)axis)->prefix, "-drawaxis_hold", &axis->hold));
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawAxisGetLimits -  Gets the limits (in user coords) of the axis

  Not Collective

  Input Parameters:
+ axis - the axis
. xmin - the lower x limit
. xmax - the upper x limit
. ymin - the lower y limit
- ymax - the upper y limit

  Level: advanced

.seealso: `PetscDrawAxisCreate()`, `PetscDrawAxis`, `PetscDrawAxisSetHoldLimits()`, `PetscDrawAxisSetLimits()`, `PetscDrawAxisSetLabels()`, `PetscDrawAxisSetColors()`
@*/
PetscErrorCode PetscDrawAxisGetLimits(PetscDrawAxis axis, PetscReal *xmin, PetscReal *xmax, PetscReal *ymin, PetscReal *ymax)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(axis, PETSC_DRAWAXIS_CLASSID, 1);
  if (xmin) *xmin = axis->xlow;
  if (xmax) *xmax = axis->xhigh;
  if (ymin) *ymin = axis->ylow;
  if (ymax) *ymax = axis->yhigh;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawAxisSetHoldLimits -  Causes an axis to keep the same limits until this is called
  again

  Logically Collective

  Input Parameters:
+ axis - the axis
- hold - `PETSC_TRUE` - hold current limits, `PETSC_FALSE` allow limits to be changed

  Level: advanced

  Note:
  Once this has been called with `PETSC_TRUE` the limits will not change if you call
  `PetscDrawAxisSetLimits()` until you call this with `PETSC_FALSE`

.seealso: `PetscDrawAxisCreate()`, `PetscDrawAxis`, `PetscDrawAxisGetLimits()`, `PetscDrawAxisSetLimits()`, `PetscDrawAxisSetLabels()`, `PetscDrawAxisSetColors()`
@*/
PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis axis, PetscBool hold)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(axis, PETSC_DRAWAXIS_CLASSID, 1);
  PetscValidLogicalCollectiveBool(axis, hold, 2);
  axis->hold = hold;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawAxisDraw - draws an axis.

  Collective

  Input Parameter:
. axis - `PetscDrawAxis` structure

  Level: advanced

  Note:
  This draws the actual axis.  The limits etc have already been set.
  By picking special routines for the ticks and labels, special
  effects may be generated.  These routines are part of the Axis
  structure (axis).

.seealso: `PetscDrawAxisCreate()`, `PetscDrawAxis`, `PetscDrawAxisGetLimits()`, `PetscDrawAxisSetLimits()`, `PetscDrawAxisSetLabels()`, `PetscDrawAxisSetColors()`
@*/
PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis axis)
{
  int         i, ntick, numx, numy, ac, tc, cc;
  PetscMPIInt rank;
  size_t      len, ytlen = 0;
  PetscReal   coors[4], tickloc[PETSC_DRAW_AXIS_MAX_SEGMENTS], sep, tw, th;
  PetscReal   xl, xr, yl, yr, dxl = 0, dyl = 0, dxr = 0, dyr = 0;
  char       *p;
  PetscDraw   draw;
  PetscBool   isnull;

  PetscFunctionBegin;
  PetscValidHeaderSpecific(axis, PETSC_DRAWAXIS_CLASSID, 1);
  PetscCall(PetscDrawIsNull(axis->win, &isnull));
  if (isnull) PetscFunctionReturn(PETSC_SUCCESS);
  PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)axis), &rank));

  draw = axis->win;

  ac = axis->ac;
  tc = axis->tc;
  cc = axis->cc;
  if (axis->xlow == axis->xhigh) {
    axis->xlow -= .5;
    axis->xhigh += .5;
  }
  if (axis->ylow == axis->yhigh) {
    axis->ylow -= .5;
    axis->yhigh += .5;
  }

  PetscDrawCollectiveBegin(draw);
  if (rank) goto finally;

  /* get canonical string size */
  PetscCall(PetscDrawSetCoordinates(draw, 0, 0, 1, 1));
  PetscCall(PetscDrawStringGetSize(draw, &tw, &th));
  /* lower spacing */
  if (axis->xlabelstr) dyl += 1.5 * th;
  if (axis->xlabel) dyl += 1.5 * th;
  /* left spacing */
  if (axis->ylabelstr) dxl += 7.5 * tw;
  if (axis->ylabel) dxl += 2.0 * tw;
  /* right and top spacing */
  if (axis->xlabelstr) dxr = 2.5 * tw;
  if (axis->ylabelstr) dyr = 0.5 * th;
  if (axis->toplabel) dyr = 1.5 * th;
  /* extra spacing */
  dxl += 0.7 * tw;
  dxr += 0.5 * tw;
  dyl += 0.2 * th;
  dyr += 0.2 * th;
  /* determine coordinates */
  xl = (dxl * axis->xhigh + dxr * axis->xlow - axis->xlow) / (dxl + dxr - 1);
  xr = (dxl * axis->xhigh + dxr * axis->xlow - axis->xhigh) / (dxl + dxr - 1);
  yl = (dyl * axis->yhigh + dyr * axis->ylow - axis->ylow) / (dyl + dyr - 1);
  yr = (dyl * axis->yhigh + dyr * axis->ylow - axis->yhigh) / (dyl + dyr - 1);
  PetscCall(PetscDrawSetCoordinates(draw, xl, yl, xr, yr));
  PetscCall(PetscDrawStringGetSize(draw, &tw, &th));

  /* PetscDraw the axis lines */
  PetscCall(PetscDrawLine(draw, axis->xlow, axis->ylow, axis->xhigh, axis->ylow, ac));
  PetscCall(PetscDrawLine(draw, axis->xlow, axis->ylow, axis->xlow, axis->yhigh, ac));
  PetscCall(PetscDrawLine(draw, axis->xlow, axis->yhigh, axis->xhigh, axis->yhigh, ac));
  PetscCall(PetscDrawLine(draw, axis->xhigh, axis->ylow, axis->xhigh, axis->yhigh, ac));

  /* PetscDraw the top label */
  if (axis->toplabel) {
    PetscReal x = (axis->xlow + axis->xhigh) / 2, y = axis->yhigh + 0.5 * th;

    PetscCall(PetscDrawStringCentered(draw, x, y, cc, axis->toplabel));
  }

  /* PetscDraw the X ticks and labels */
  if (axis->xticks) {
    numx = (int)(.15 * (axis->xhigh - axis->xlow) / tw);
    numx = PetscClipInterval(numx, 2, 6);
    PetscCall((*axis->xticks)(axis->xlow, axis->xhigh, numx, &ntick, tickloc, PETSC_DRAW_AXIS_MAX_SEGMENTS));
    /* PetscDraw in tick marks */
    for (i = 0; i < ntick; i++) {
      PetscCall(PetscDrawLine(draw, tickloc[i], axis->ylow, tickloc[i], axis->ylow + .5 * th, tc));
      PetscCall(PetscDrawLine(draw, tickloc[i], axis->yhigh, tickloc[i], axis->yhigh - .5 * th, tc));
    }
    /* label ticks */
    if (axis->xlabelstr) {
      for (i = 0; i < ntick; i++) {
        if (i < ntick - 1) sep = tickloc[i + 1] - tickloc[i];
        else if (i > 0) sep = tickloc[i] - tickloc[i - 1];
        else sep = 0.0;
        PetscCall((*axis->xlabelstr)(tickloc[i], sep, &p));
        PetscCall(PetscDrawStringCentered(draw, tickloc[i], axis->ylow - 1.5 * th, cc, p));
      }
    }
  }
  if (axis->xlabel) {
    PetscReal x = (axis->xlow + axis->xhigh) / 2, y = axis->ylow - 1.5 * th;

    if (axis->xlabelstr) y -= 1.5 * th;
    PetscCall(PetscDrawStringCentered(draw, x, y, cc, axis->xlabel));
  }

  /* PetscDraw the Y ticks and labels */
  if (axis->yticks) {
    numy = (int)(.50 * (axis->yhigh - axis->ylow) / th);
    numy = PetscClipInterval(numy, 2, 6);
    PetscCall((*axis->yticks)(axis->ylow, axis->yhigh, numy, &ntick, tickloc, PETSC_DRAW_AXIS_MAX_SEGMENTS));
    /* PetscDraw in tick marks */
    for (i = 0; i < ntick; i++) {
      PetscCall(PetscDrawLine(draw, axis->xlow, tickloc[i], axis->xlow + .5 * tw, tickloc[i], tc));
      PetscCall(PetscDrawLine(draw, axis->xhigh, tickloc[i], axis->xhigh - .5 * tw, tickloc[i], tc));
    }
    /* label ticks */
    if (axis->ylabelstr) {
      for (i = 0; i < ntick; i++) {
        if (i < ntick - 1) sep = tickloc[i + 1] - tickloc[i];
        else if (i > 0) sep = tickloc[i] - tickloc[i - 1];
        else sep = 0.0;
        PetscCall((*axis->ylabelstr)(tickloc[i], sep, &p));
        PetscCall(PetscStrlen(p, &len));
        ytlen = PetscMax(ytlen, len);
        PetscCall(PetscDrawString(draw, axis->xlow - ((PetscReal)len + .5) * tw, tickloc[i] - .5 * th, cc, p));
      }
    }
  }
  if (axis->ylabel) {
    PetscReal x = axis->xlow - 2.0 * tw, y = (axis->ylow + axis->yhigh) / 2;

    if (axis->ylabelstr) x -= ((PetscReal)ytlen + .5) * tw;
    PetscCall(PetscStrlen(axis->ylabel, &len));
    PetscCall(PetscDrawStringVertical(draw, x, y + ((PetscReal)len) * th / 2, cc, axis->ylabel));
  }

  PetscCall(PetscDrawGetCoordinates(draw, &coors[0], &coors[1], &coors[2], &coors[3]));
finally:
  PetscDrawCollectiveEnd(draw);
  PetscCallMPI(MPI_Bcast(coors, 4, MPIU_REAL, 0, PetscObjectComm((PetscObject)draw)));
  PetscCall(PetscDrawSetCoordinates(draw, coors[0], coors[1], coors[2], coors[3]));
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*
    Removes all zeros but one from .0000
*/
PetscErrorCode PetscStripe0(char *buf)
{
  size_t    n;
  PetscBool flg;
  char     *str = NULL;

  PetscFunctionBegin;
  PetscCall(PetscStrlen(buf, &n));
  PetscCall(PetscStrendswith(buf, "e00", &flg));
  if (flg) buf[n - 3] = 0;
  PetscCall(PetscStrstr(buf, "e0", &str));
  if (str) {
    buf[n - 2] = buf[n - 1];
    buf[n - 1] = 0;
  }
  PetscCall(PetscStrstr(buf, "e-0", &str));
  if (str) {
    buf[n - 2] = buf[n - 1];
    buf[n - 1] = 0;
  }
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*
    Removes all zeros but one from .0000
*/
PetscErrorCode PetscStripAllZeros(char *buf)
{
  size_t i, n;

  PetscFunctionBegin;
  PetscCall(PetscStrlen(buf, &n));
  if (buf[0] != '.') PetscFunctionReturn(PETSC_SUCCESS);
  for (i = 1; i < n; i++) {
    if (buf[i] != '0') PetscFunctionReturn(PETSC_SUCCESS);
  }
  buf[0] = '0';
  buf[1] = 0;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*
    Removes trailing zeros
*/
#if (PETSC_SIZEOF_SIZE_T == 8)
  #define MAX_SIZE_T PETSC_INT64_MAX
#else
  #define MAX_SIZE_T INT_MAX
#endif
PetscErrorCode PetscStripTrailingZeros(char *buf)
{
  char  *found = NULL;
  size_t i, n, m = MAX_SIZE_T;

  PetscFunctionBegin;
  /* if there is an e in string DO NOT strip trailing zeros */
  PetscCall(PetscStrchr(buf, 'e', &found));
  if (found) PetscFunctionReturn(PETSC_SUCCESS);

  PetscCall(PetscStrlen(buf, &n));
  /* locate decimal point */
  for (i = 0; i < n; i++) {
    if (buf[i] == '.') {
      m = i;
      break;
    }
  }
  /* if not decimal point then no zeros to remove */
  if (m == MAX_SIZE_T) PetscFunctionReturn(PETSC_SUCCESS);
  /* start at right end of string removing 0s */
  for (i = n - 1; i > m; i++) {
    if (buf[i] != '0') PetscFunctionReturn(PETSC_SUCCESS);
    buf[i] = 0;
  }
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*
    Removes leading 0 from 0.22 or -0.22
*/
PetscErrorCode PetscStripInitialZero(char *buf)
{
  size_t i, n;

  PetscFunctionBegin;
  PetscCall(PetscStrlen(buf, &n));
  if (buf[0] == '0') {
    for (i = 0; i < n; i++) buf[i] = buf[i + 1];
  } else if (buf[0] == '-' && buf[1] == '0') {
    for (i = 1; i < n; i++) buf[i] = buf[i + 1];
  }
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*
     Removes the extraneous zeros in numbers like 1.10000e6
*/
PetscErrorCode PetscStripZeros(char *buf)
{
  size_t i, j, n;

  PetscFunctionBegin;
  PetscCall(PetscStrlen(buf, &n));
  if (n < 5) PetscFunctionReturn(PETSC_SUCCESS);
  for (i = 1; i < n - 1; i++) {
    if (buf[i] == 'e' && buf[i - 1] == '0') {
      for (j = i; j < n + 1; j++) buf[j - 1] = buf[j];
      PetscCall(PetscStripZeros(buf));
      PetscFunctionReturn(PETSC_SUCCESS);
    }
  }
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*
      Removes the plus in something like 1.1e+2 or 1.1e+02
*/
PetscErrorCode PetscStripZerosPlus(char *buf)
{
  size_t i, j, n;

  PetscFunctionBegin;
  PetscCall(PetscStrlen(buf, &n));
  if (n < 5) PetscFunctionReturn(PETSC_SUCCESS);
  for (i = 1; i < n - 2; i++) {
    if (buf[i] == '+') {
      if (buf[i + 1] == '0') {
        for (j = i + 1; j < n; j++) buf[j - 1] = buf[j + 1];
        PetscFunctionReturn(PETSC_SUCCESS);
      } else {
        for (j = i + 1; j < n + 1; j++) buf[j - 1] = buf[j];
        PetscFunctionReturn(PETSC_SUCCESS);
      }
    } else if (buf[i] == '-') {
      if (buf[i + 1] == '0') {
        for (j = i + 1; j < n; j++) buf[j] = buf[j + 1];
        PetscFunctionReturn(PETSC_SUCCESS);
      }
    }
  }
  PetscFunctionReturn(PETSC_SUCCESS);
}