share/draw/drawutils.texi

   1 \input texinfo
   2
   3 @c makeinfo drawutils.texi         to make .info
   4 @c texi2html drawutils.texi        to make .html
   5 @c texi2pdf drawutils.texi         to make .pdf
   6
   7 @setfilename drawutils.info
   8 @settitle drawutils
   9
  10 @ifinfo
  11 @macro var {expr}
  12 <\expr\>
  13 @end macro
  14 @end ifinfo
  15
  16 @dircategory Mathematics/Maxima
  17 @direntry
  18 * drawutils: (maxima/drawutils).           Maxima share package drawutils: additional drawing functions for package draw.
  19 @end direntry
  20
  21 @node Top, Introduction to drawutils, (dir), (dir)
  22 @top
  23 @menu
  24 * Introduction to drawutils::
  25 * Vector fields::
  26 * Venn diagrams::
  27 * Function and variable index::
  28 @end menu
  29
  30 @node Introduction to drawutils, Vector fields, Top, Top
  31 @chapter Introduction to drawutils
  32
  33 Package @code{drawutils} contains user contributed code based on the @code{draw} package.
  34
  35
  36 @node Vector fields, Venn diagrams, Introduction to drawutils, Top
  37 @chapter Vector fields
  38
  39 By Donald J. Bindner (2010)
  40
  41 Functions for plotting vector fields in 2D and 3D.
  42
  43
  44 @deffn {Function} plot_vector_field (@var{F}, @var{X}, @var{Y}, ... )
  45 Draws a 2D vector field.
  46
  47 Arguments:
  48
  49 @itemize @bullet
  50
  51 @item
  52 @var{F}: a vector containing field components.
  53
  54 @item
  55 @var{X}: name and bounds of first coordinate.
  56
  57 @item
  58 @var{Y}: name and bounds of second coordinate.
  59
  60 @end itemize
  61
  62 Optional parameters:
  63
  64 @itemize @bullet
  65 @item
  66 Those defined in the @code{draw} package.
  67 @item
  68 @var{scale=1}: auto-scaling of arrows (default).
  69
  70 @item
  71 @var{scale=0}: no auto-scaling.
  72
  73 @item
  74 @var{scale=*}: adjust arrows shorter -- numbers between 0 and 1 or longer -- numbers greater than 1.
  75
  76 @end itemize
  77
  78 Examples:
  79
  80 @example
  81 (%i1) load(drawutils)$
  82 (%i2) plot_vector_field([-y,x], [x,-1,1], [y,-1,1])$
  83 (%i3) plot_vector_field([-y,x], [x,-1,1], [y,-1,1],
  84                         scale=0)$
  85 @end example
  86
  87 @end deffn
  88
  89
  90 @deffn {Function} plot_vector_field3d (@var{F}, @var{X}, @var{Y}, @var{Z},  ... )
  91 Draws a 3D vector field.
  92
  93 Arguments:
  94
  95 @itemize @bullet
  96
  97 @item
  98 @var{F}: a vector containing field components.
  99
 100 @item
 101 @var{X}: name and bounds of first coordinate.
 102
 103 @item
 104 @var{Y}: name and bounds of second coordinate.
 105
 106 @item
 107 @var{Z}: name and bounds of third coordinate.
 108
 109 @end itemize
 110
 111 Optional parameters:
 112
 113 @itemize @bullet
 114 @item
 115 Those defined in the @code{draw} package.
 116 @item
 117 @var{scale=1}: auto-scaling of arrows (default).
 118
 119 @item
 120 @var{scale=0}: no auto-scaling.
 121
 122 @item
 123 @var{scale=*}: adjust arrows shorter -- numbers between 0 and 1 or longer -- numbers greater than 1.
 124
 125 @end itemize
 126
 127 Examples:
 128
 129 @example
 130 (%i1) load(drawutils)$
 131 (%i2) plot_vector_field3d([-y,x,z], [x,-1,1], [y,-1,1], [z,-1,1])$
 132 (%i3) plot_vector_field3d([-y,x,z], [x,-1,1], [y,-1,1], [z,-1,1],
 133                           scale=0)$
 134 @end example
 135
 136 @end deffn
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151 @node Venn diagrams, Function and variable index, Vector fields, Top
 152 @chapter Venn diagrams
 153
 154 By Pankaj Sejwal (2015)
 155
 156 The @emph{vennplot} package enables the user to plot Venn diagram for any logical
 157 relation. Logical atoms are represented as equally distanced circles of different
 158 random colours which help in distinguishing different circles.
 159
 160 No known bug, but in case some issue needs to be addressed, please share it on
 161 Maxima mailing list.
 162
 163 @deffn {Function} vennplot (@var{logical_expression})
 164 Draws a basicVenn diagram.
 165
 166 Examples:
 167
 168 @example
 169 (%i1) load(drawutils)$
 170 (%i2) vennplot(a and b and not(c) and d)$
 171 (%i3) vennplot(a and b and c and d)$
 172 (%i4) vennplot(not(d))$
 173 @end example
 174
 175 TODO : Filling circles with different colors
 176
 177 @end deffn
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196 @node Function and variable index,  , Venn diagrams, Top
 197 @appendix Function and variable index
 198 @printindex fn
 199 @c @printindex vr
 200
 201 @bye