PPDIPO(3NCARG)

πŸ“¦ version 6.6.2, in epel 9, fedora 43, fedora 44

πŸ’– PPDIPO πŸ’–

okay bestie, so this is a page from the NCAR GRAPHICS manual β€” it's PPDIPO, living in section 3NCARG. it's giving computational geometry, it's giving polygon math, and honestly? it's kind of iconic. let's get into it πŸ¦‹


✨ NAME ✨

PPDIPO β€” generates and returns the boundary of the "difference" polygon, which consists of all points that are inside the subject polygon but not inside the clip polygon.

fr fr that's it. subject minus clip. the little "what's left over" region. slay. πŸ’…

🌸 SYNOPSIS 🌸

CALL PPDIPO (XCCP,YCCP,NCCP,XCSP,YCSP,NCSP,RWRK,IWRK,NWRK,URPP,IERR)

πŸŽ€ C-BINDING SYNOPSIS πŸŽ€

#include <ncarg/ncargC.h>

void c_ppdipo(
     float *xccp,
     float *yccp,
     int nccp,
     float *xcsp,
     float *ycsp,
     int ncsp,
     float *rwrk,
     int *iwrk,
     int nwrk,
     int (*urpp_)( float *xcra, float *ycra, int *ncra),
     int *ierr)

πŸ‘‘ DESCRIPTION πŸ‘‘

  • XCCP β€” (an input array of type REAL) the X coordinate array for the clip polygon. that's the scissors βœ‚οΈ one.
  • YCCP β€” (an input array of type REAL) the Y coordinate array for the clip polygon.
  • NCCP β€” (an input expression of type INTEGER) the number of points defining the clip polygon. so like, how many dots make up the clip shape.
  • XCSP β€” (an input array of type REAL) the X coordinate array for the subject polygon. the main character πŸ’–
  • YCSP β€” (an input array of type REAL) the Y coordinate array for the subject polygon.
  • NCSP β€” (an input expression of type INTEGER) the number of points defining the subject polygon.
  • RWRK β€” (a scratch array, dimensioned NWRK, of type REAL) a real workspace array. Because of the way in which they are used, RWRK and IWRK may be EQUIVALENCEd (and, to save space, they should be). 🫢
  • IWRK β€” (a scratch array, dimensioned NWRK, of type INTEGER) an integer workspace array. Because of the way in which they are used, RWRK and IWRK may be EQUIVALENCEd (and, to save space, they should be). yes bestie, same sentence, that's just how it is, they're a package deal.
  • NWRK β€” (an input expression of type INTEGER) the length of the workspace array(s). ngl, it is a bit difficult to describe how much space might be required. At the moment, I would recommend using NWRK equal to about ten times the total of the number of points in the input polygons and the number of intersection points. This situation will change with time; at the very least, I would like to put in an internal parameter that will tell one how much space was actually used on a given call, but I have not yet done so. πŸ’€ (author is being so real about it)
  • URPP β€” is the name of a user-provided routine to process the polygon-boundary pieces. This name must appear in an EXTERNAL statement in the routine that calls PPDIPO and the routine itself must have the following form:
     SUBROUTINE URPP (XCRA,YCRA,NCRA)
       DIMENSION XCRA(NCRA),YCRA(NCRA)
       ...(code to process a polygon boundary piece)...
       RETURN
     END

Each of the arguments XCRA and YCRA is a real array, dimensioned NCRA; the former holds the X coordinates, and the latter the Y coordinates, of a piece of the polygon boundary. It will be the case that XCRA(NCRA)=XCRA(1) and YCRA(NCRA)=YCRA(1). (so it closes back up on itself, cute πŸŽ€)

  • IERR β€” (an output variable of type INTEGER) is returned with the value zero if no errors occurred in the execution of PPDIPO or with a small positive value if an error did occur. Here's the breakdown, no cap:
    • the value 1 indicates that a degenerate clip polygon was detected
    • the value 2 indicates that a degenerate subject polygon was detected
    • the value 3 indicates that the workspace provided was too small

values greater than 3 should be reported to the author, as they indicate some problem with the algorithm. 😭 Currently, if IERR is returned non-zero, one can be sure that no calls to URPP were executed; in the future, this could change, but, in that case, there will be an internal parameter allowing one to request the current behavior.


🧚 C-BINDING DESCRIPTION 🧚

The C-binding argument descriptions are the same as the FORTRAN argument descriptions. literally identical bestie, no notes. πŸ’œ


πŸ”₯ USAGE πŸ”₯

The FORTRAN statement

CALL PPDIPO (XCCP,YCCP,NCCP,XCSP,YCSP,NCSP,RWRK,IWRK,NWRK,URPP,IERR)

causes the formation of a difference polygon (the subject polygon minus the clip polygon) and the delivery of that polygon's boundary, piece by piece, to the user-specified polygon-processing routine URPP. it's giving ✨assembly line✨ but make it geometry.


🌈 EXAMPLES 🌈

Use the ncargex command to see the following relevant examples: ppex01, tppack, c_ppex01. go look, they ate. πŸ’…


⭐ ACCESS ⭐

To use PPDIPO or c_ppdipo, load the NCAR Graphics libraries ncarg, ncarg_gks, and ncarg_c, preferably in that order. (order matters bestie, don't do it wrong πŸ™ˆ)


πŸ¦‹ SEE ALSO πŸ¦‹

  • Online: polypack, ppditr, ppinpo, ppintr, ppplcl, ppppap, ppunpo, ppuntr, ncarg_cbind.
  • Hardcopy: None. (none. zero. nada. moving on 😭)

Copyright (C) 1987-2009
University Corporation for Atmospheric Research
The use of this Software is governed by a License Agreement.

okay that's the whole page, you're officially a polygon girlie now πŸ‘‘ this was PPDIPO(3NCARG), from the UNIX manual, dated March 1995 β€” yeah it's vintage, and it's still serving. go process some boundaries, bestie. mwah πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from