ViewVC logotype

Annotation of /to_be_filed/sf_code/esrgpcpj/shared/c_datd/cvxzone.h

Parent Directory Parent Directory | Revision Log Revision Log

Revision 29 - (hide annotations) (download)
Sat Oct 8 07:08:47 2016 UTC (7 years, 9 months ago) by dashley
File MIME type: text/plain
File size: 50430 byte(s)
Directories relocated.
1 dashley 25 /* $Header: /cvsroot/esrg/sfesrg/esrgpcpj/shared/c_datd/cvxzone.h,v 1.4 2001/10/25 05:33:05 dtashley Exp $
2     **
3     ** Module to deal with convex zones for verification.
4     */
6     //--------------------------------------------------------------------------------
7     //Copyright 2001 David T. Ashley
8     //-------------------------------------------------------------------------------------------------
9     //This source code and any program in which it is compiled/used is provided under the GNU GENERAL
10     //PUBLIC LICENSE, Version 3, full license text below.
11     //-------------------------------------------------------------------------------------------------
13     // Version 3, 29 June 2007
14     //
15     // Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
16     // Everyone is permitted to copy and distribute verbatim copies
17     // of this license document, but changing it is not allowed.
18     //
19     // Preamble
20     //
21     // The GNU General Public License is a free, copyleft license for
22     //software and other kinds of works.
23     //
24     // The licenses for most software and other practical works are designed
25     //to take away your freedom to share and change the works. By contrast,
26     //the GNU General Public License is intended to guarantee your freedom to
27     //share and change all versions of a program--to make sure it remains free
28     //software for all its users. We, the Free Software Foundation, use the
29     //GNU General Public License for most of our software; it applies also to
30     //any other work released this way by its authors. You can apply it to
31     //your programs, too.
32     //
33     // When we speak of free software, we are referring to freedom, not
34     //price. Our General Public Licenses are designed to make sure that you
35     //have the freedom to distribute copies of free software (and charge for
36     //them if you wish), that you receive source code or can get it if you
37     //want it, that you can change the software or use pieces of it in new
38     //free programs, and that you know you can do these things.
39     //
40     // To protect your rights, we need to prevent others from denying you
41     //these rights or asking you to surrender the rights. Therefore, you have
42     //certain responsibilities if you distribute copies of the software, or if
43     //you modify it: responsibilities to respect the freedom of others.
44     //
45     // For example, if you distribute copies of such a program, whether
46     //gratis or for a fee, you must pass on to the recipients the same
47     //freedoms that you received. You must make sure that they, too, receive
48     //or can get the source code. And you must show them these terms so they
49     //know their rights.
50     //
51     // Developers that use the GNU GPL protect your rights with two steps:
52     //(1) assert copyright on the software, and (2) offer you this License
53     //giving you legal permission to copy, distribute and/or modify it.
54     //
55     // For the developers' and authors' protection, the GPL clearly explains
56     //that there is no warranty for this free software. For both users' and
57     //authors' sake, the GPL requires that modified versions be marked as
58     //changed, so that their problems will not be attributed erroneously to
59     //authors of previous versions.
60     //
61     // Some devices are designed to deny users access to install or run
62     //modified versions of the software inside them, although the manufacturer
63     //can do so. This is fundamentally incompatible with the aim of
64     //protecting users' freedom to change the software. The systematic
65     //pattern of such abuse occurs in the area of products for individuals to
66     //use, which is precisely where it is most unacceptable. Therefore, we
67     //have designed this version of the GPL to prohibit the practice for those
68     //products. If such problems arise substantially in other domains, we
69     //stand ready to extend this provision to those domains in future versions
70     //of the GPL, as needed to protect the freedom of users.
71     //
72     // Finally, every program is threatened constantly by software patents.
73     //States should not allow patents to restrict development and use of
74     //software on general-purpose computers, but in those that do, we wish to
75     //avoid the special danger that patents applied to a free program could
76     //make it effectively proprietary. To prevent this, the GPL assures that
77     //patents cannot be used to render the program non-free.
78     //
79     // The precise terms and conditions for copying, distribution and
80     //modification follow.
81     //
83     //
84     // 0. Definitions.
85     //
86     // "This License" refers to version 3 of the GNU General Public License.
87     //
88     // "Copyright" also means copyright-like laws that apply to other kinds of
89     //works, such as semiconductor masks.
90     //
91     // "The Program" refers to any copyrightable work licensed under this
92     //License. Each licensee is addressed as "you". "Licensees" and
93     //"recipients" may be individuals or organizations.
94     //
95     // To "modify" a work means to copy from or adapt all or part of the work
96     //in a fashion requiring copyright permission, other than the making of an
97     //exact copy. The resulting work is called a "modified version" of the
98     //earlier work or a work "based on" the earlier work.
99     //
100     // A "covered work" means either the unmodified Program or a work based
101     //on the Program.
102     //
103     // To "propagate" a work means to do anything with it that, without
104     //permission, would make you directly or secondarily liable for
105     //infringement under applicable copyright law, except executing it on a
106     //computer or modifying a private copy. Propagation includes copying,
107     //distribution (with or without modification), making available to the
108     //public, and in some countries other activities as well.
109     //
110     // To "convey" a work means any kind of propagation that enables other
111     //parties to make or receive copies. Mere interaction with a user through
112     //a computer network, with no transfer of a copy, is not conveying.
113     //
114     // An interactive user interface displays "Appropriate Legal Notices"
115     //to the extent that it includes a convenient and prominently visible
116     //feature that (1) displays an appropriate copyright notice, and (2)
117     //tells the user that there is no warranty for the work (except to the
118     //extent that warranties are provided), that licensees may convey the
119     //work under this License, and how to view a copy of this License. If
120     //the interface presents a list of user commands or options, such as a
121     //menu, a prominent item in the list meets this criterion.
122     //
123     // 1. Source Code.
124     //
125     // The "source code" for a work means the preferred form of the work
126     //for making modifications to it. "Object code" means any non-source
127     //form of a work.
128     //
129     // A "Standard Interface" means an interface that either is an official
130     //standard defined by a recognized standards body, or, in the case of
131     //interfaces specified for a particular programming language, one that
132     //is widely used among developers working in that language.
133     //
134     // The "System Libraries" of an executable work include anything, other
135     //than the work as a whole, that (a) is included in the normal form of
136     //packaging a Major Component, but which is not part of that Major
137     //Component, and (b) serves only to enable use of the work with that
138     //Major Component, or to implement a Standard Interface for which an
139     //implementation is available to the public in source code form. A
140     //"Major Component", in this context, means a major essential component
141     //(kernel, window system, and so on) of the specific operating system
142     //(if any) on which the executable work runs, or a compiler used to
143     //produce the work, or an object code interpreter used to run it.
144     //
145     // The "Corresponding Source" for a work in object code form means all
146     //the source code needed to generate, install, and (for an executable
147     //work) run the object code and to modify the work, including scripts to
148     //control those activities. However, it does not include the work's
149     //System Libraries, or general-purpose tools or generally available free
150     //programs which are used unmodified in performing those activities but
151     //which are not part of the work. For example, Corresponding Source
152     //includes interface definition files associated with source files for
153     //the work, and the source code for shared libraries and dynamically
154     //linked subprograms that the work is specifically designed to require,
155     //such as by intimate data communication or control flow between those
156     //subprograms and other parts of the work.
157     //
158     // The Corresponding Source need not include anything that users
159     //can regenerate automatically from other parts of the Corresponding
160     //Source.
161     //
162     // The Corresponding Source for a work in source code form is that
163     //same work.
164     //
165     // 2. Basic Permissions.
166     //
167     // All rights granted under this License are granted for the term of
168     //copyright on the Program, and are irrevocable provided the stated
169     //conditions are met. This License explicitly affirms your unlimited
170     //permission to run the unmodified Program. The output from running a
171     //covered work is covered by this License only if the output, given its
172     //content, constitutes a covered work. This License acknowledges your
173     //rights of fair use or other equivalent, as provided by copyright law.
174     //
175     // You may make, run and propagate covered works that you do not
176     //convey, without conditions so long as your license otherwise remains
177     //in force. You may convey covered works to others for the sole purpose
178     //of having them make modifications exclusively for you, or provide you
179     //with facilities for running those works, provided that you comply with
180     //the terms of this License in conveying all material for which you do
181     //not control copyright. Those thus making or running the covered works
182     //for you must do so exclusively on your behalf, under your direction
183     //and control, on terms that prohibit them from making any copies of
184     //your copyrighted material outside their relationship with you.
185     //
186     // Conveying under any other circumstances is permitted solely under
187     //the conditions stated below. Sublicensing is not allowed; section 10
188     //makes it unnecessary.
189     //
190     // 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
191     //
192     // No covered work shall be deemed part of an effective technological
193     //measure under any applicable law fulfilling obligations under article
194     //11 of the WIPO copyright treaty adopted on 20 December 1996, or
195     //similar laws prohibiting or restricting circumvention of such
196     //measures.
197     //
198     // When you convey a covered work, you waive any legal power to forbid
199     //circumvention of technological measures to the extent such circumvention
200     //is effected by exercising rights under this License with respect to
201     //the covered work, and you disclaim any intention to limit operation or
202     //modification of the work as a means of enforcing, against the work's
203     //users, your or third parties' legal rights to forbid circumvention of
204     //technological measures.
205     //
206     // 4. Conveying Verbatim Copies.
207     //
208     // You may convey verbatim copies of the Program's source code as you
209     //receive it, in any medium, provided that you conspicuously and
210     //appropriately publish on each copy an appropriate copyright notice;
211     //keep intact all notices stating that this License and any
212     //non-permissive terms added in accord with section 7 apply to the code;
213     //keep intact all notices of the absence of any warranty; and give all
214     //recipients a copy of this License along with the Program.
215     //
216     // You may charge any price or no price for each copy that you convey,
217     //and you may offer support or warranty protection for a fee.
218     //
219     // 5. Conveying Modified Source Versions.
220     //
221     // You may convey a work based on the Program, or the modifications to
222     //produce it from the Program, in the form of source code under the
223     //terms of section 4, provided that you also meet all of these conditions:
224     //
225     // a) The work must carry prominent notices stating that you modified
226     // it, and giving a relevant date.
227     //
228     // b) The work must carry prominent notices stating that it is
229     // released under this License and any conditions added under section
230     // 7. This requirement modifies the requirement in section 4 to
231     // "keep intact all notices".
232     //
233     // c) You must license the entire work, as a whole, under this
234     // License to anyone who comes into possession of a copy. This
235     // License will therefore apply, along with any applicable section 7
236     // additional terms, to the whole of the work, and all its parts,
237     // regardless of how they are packaged. This License gives no
238     // permission to license the work in any other way, but it does not
239     // invalidate such permission if you have separately received it.
240     //
241     // d) If the work has interactive user interfaces, each must display
242     // Appropriate Legal Notices; however, if the Program has interactive
243     // interfaces that do not display Appropriate Legal Notices, your
244     // work need not make them do so.
245     //
246     // A compilation of a covered work with other separate and independent
247     //works, which are not by their nature extensions of the covered work,
248     //and which are not combined with it such as to form a larger program,
249     //in or on a volume of a storage or distribution medium, is called an
250     //"aggregate" if the compilation and its resulting copyright are not
251     //used to limit the access or legal rights of the compilation's users
252     //beyond what the individual works permit. Inclusion of a covered work
253     //in an aggregate does not cause this License to apply to the other
254     //parts of the aggregate.
255     //
256     // 6. Conveying Non-Source Forms.
257     //
258     // You may convey a covered work in object code form under the terms
259     //of sections 4 and 5, provided that you also convey the
260     //machine-readable Corresponding Source under the terms of this License,
261     //in one of these ways:
262     //
263     // a) Convey the object code in, or embodied in, a physical product
264     // (including a physical distribution medium), accompanied by the
265     // Corresponding Source fixed on a durable physical medium
266     // customarily used for software interchange.
267     //
268     // b) Convey the object code in, or embodied in, a physical product
269     // (including a physical distribution medium), accompanied by a
270     // written offer, valid for at least three years and valid for as
271     // long as you offer spare parts or customer support for that product
272     // model, to give anyone who possesses the object code either (1) a
273     // copy of the Corresponding Source for all the software in the
274     // product that is covered by this License, on a durable physical
275     // medium customarily used for software interchange, for a price no
276     // more than your reasonable cost of physically performing this
277     // conveying of source, or (2) access to copy the
278     // Corresponding Source from a network server at no charge.
279     //
280     // c) Convey individual copies of the object code with a copy of the
281     // written offer to provide the Corresponding Source. This
282     // alternative is allowed only occasionally and noncommercially, and
283     // only if you received the object code with such an offer, in accord
284     // with subsection 6b.
285     //
286     // d) Convey the object code by offering access from a designated
287     // place (gratis or for a charge), and offer equivalent access to the
288     // Corresponding Source in the same way through the same place at no
289     // further charge. You need not require recipients to copy the
290     // Corresponding Source along with the object code. If the place to
291     // copy the object code is a network server, the Corresponding Source
292     // may be on a different server (operated by you or a third party)
293     // that supports equivalent copying facilities, provided you maintain
294     // clear directions next to the object code saying where to find the
295     // Corresponding Source. Regardless of what server hosts the
296     // Corresponding Source, you remain obligated to ensure that it is
297     // available for as long as needed to satisfy these requirements.
298     //
299     // e) Convey the object code using peer-to-peer transmission, provided
300     // you inform other peers where the object code and Corresponding
301     // Source of the work are being offered to the general public at no
302     // charge under subsection 6d.
303     //
304     // A separable portion of the object code, whose source code is excluded
305     //from the Corresponding Source as a System Library, need not be
306     //included in conveying the object code work.
307     //
308     // A "User Product" is either (1) a "consumer product", which means any
309     //tangible personal property which is normally used for personal, family,
310     //or household purposes, or (2) anything designed or sold for incorporation
311     //into a dwelling. In determining whether a product is a consumer product,
312     //doubtful cases shall be resolved in favor of coverage. For a particular
313     //product received by a particular user, "normally used" refers to a
314     //typical or common use of that class of product, regardless of the status
315     //of the particular user or of the way in which the particular user
316     //actually uses, or expects or is expected to use, the product. A product
317     //is a consumer product regardless of whether the product has substantial
318     //commercial, industrial or non-consumer uses, unless such uses represent
319     //the only significant mode of use of the product.
320     //
321     // "Installation Information" for a User Product means any methods,
322     //procedures, authorization keys, or other information required to install
323     //and execute modified versions of a covered work in that User Product from
324     //a modified version of its Corresponding Source. The information must
325     //suffice to ensure that the continued functioning of the modified object
326     //code is in no case prevented or interfered with solely because
327     //modification has been made.
328     //
329     // If you convey an object code work under this section in, or with, or
330     //specifically for use in, a User Product, and the conveying occurs as
331     //part of a transaction in which the right of possession and use of the
332     //User Product is transferred to the recipient in perpetuity or for a
333     //fixed term (regardless of how the transaction is characterized), the
334     //Corresponding Source conveyed under this section must be accompanied
335     //by the Installation Information. But this requirement does not apply
336     //if neither you nor any third party retains the ability to install
337     //modified object code on the User Product (for example, the work has
338     //been installed in ROM).
339     //
340     // The requirement to provide Installation Information does not include a
341     //requirement to continue to provide support service, warranty, or updates
342     //for a work that has been modified or installed by the recipient, or for
343     //the User Product in which it has been modified or installed. Access to a
344     //network may be denied when the modification itself materially and
345     //adversely affects the operation of the network or violates the rules and
346     //protocols for communication across the network.
347     //
348     // Corresponding Source conveyed, and Installation Information provided,
349     //in accord with this section must be in a format that is publicly
350     //documented (and with an implementation available to the public in
351     //source code form), and must require no special password or key for
352     //unpacking, reading or copying.
353     //
354     // 7. Additional Terms.
355     //
356     // "Additional permissions" are terms that supplement the terms of this
357     //License by making exceptions from one or more of its conditions.
358     //Additional permissions that are applicable to the entire Program shall
359     //be treated as though they were included in this License, to the extent
360     //that they are valid under applicable law. If additional permissions
361     //apply only to part of the Program, that part may be used separately
362     //under those permissions, but the entire Program remains governed by
363     //this License without regard to the additional permissions.
364     //
365     // When you convey a copy of a covered work, you may at your option
366     //remove any additional permissions from that copy, or from any part of
367     //it. (Additional permissions may be written to require their own
368     //removal in certain cases when you modify the work.) You may place
369     //additional permissions on material, added by you to a covered work,
370     //for which you have or can give appropriate copyright permission.
371     //
372     // Notwithstanding any other provision of this License, for material you
373     //add to a covered work, you may (if authorized by the copyright holders of
374     //that material) supplement the terms of this License with terms:
375     //
376     // a) Disclaiming warranty or limiting liability differently from the
377     // terms of sections 15 and 16 of this License; or
378     //
379     // b) Requiring preservation of specified reasonable legal notices or
380     // author attributions in that material or in the Appropriate Legal
381     // Notices displayed by works containing it; or
382     //
383     // c) Prohibiting misrepresentation of the origin of that material, or
384     // requiring that modified versions of such material be marked in
385     // reasonable ways as different from the original version; or
386     //
387     // d) Limiting the use for publicity purposes of names of licensors or
388     // authors of the material; or
389     //
390     // e) Declining to grant rights under trademark law for use of some
391     // trade names, trademarks, or service marks; or
392     //
393     // f) Requiring indemnification of licensors and authors of that
394     // material by anyone who conveys the material (or modified versions of
395     // it) with contractual assumptions of liability to the recipient, for
396     // any liability that these contractual assumptions directly impose on
397     // those licensors and authors.
398     //
399     // All other non-permissive additional terms are considered "further
400     //restrictions" within the meaning of section 10. If the Program as you
401     //received it, or any part of it, contains a notice stating that it is
402     //governed by this License along with a term that is a further
403     //restriction, you may remove that term. If a license document contains
404     //a further restriction but permits relicensing or conveying under this
405     //License, you may add to a covered work material governed by the terms
406     //of that license document, provided that the further restriction does
407     //not survive such relicensing or conveying.
408     //
409     // If you add terms to a covered work in accord with this section, you
410     //must place, in the relevant source files, a statement of the
411     //additional terms that apply to those files, or a notice indicating
412     //where to find the applicable terms.
413     //
414     // Additional terms, permissive or non-permissive, may be stated in the
415     //form of a separately written license, or stated as exceptions;
416     //the above requirements apply either way.
417     //
418     // 8. Termination.
419     //
420     // You may not propagate or modify a covered work except as expressly
421     //provided under this License. Any attempt otherwise to propagate or
422     //modify it is void, and will automatically terminate your rights under
423     //this License (including any patent licenses granted under the third
424     //paragraph of section 11).
425     //
426     // However, if you cease all violation of this License, then your
427     //license from a particular copyright holder is reinstated (a)
428     //provisionally, unless and until the copyright holder explicitly and
429     //finally terminates your license, and (b) permanently, if the copyright
430     //holder fails to notify you of the violation by some reasonable means
431     //prior to 60 days after the cessation.
432     //
433     // Moreover, your license from a particular copyright holder is
434     //reinstated permanently if the copyright holder notifies you of the
435     //violation by some reasonable means, this is the first time you have
436     //received notice of violation of this License (for any work) from that
437     //copyright holder, and you cure the violation prior to 30 days after
438     //your receipt of the notice.
439     //
440     // Termination of your rights under this section does not terminate the
441     //licenses of parties who have received copies or rights from you under
442     //this License. If your rights have been terminated and not permanently
443     //reinstated, you do not qualify to receive new licenses for the same
444     //material under section 10.
445     //
446     // 9. Acceptance Not Required for Having Copies.
447     //
448     // You are not required to accept this License in order to receive or
449     //run a copy of the Program. Ancillary propagation of a covered work
450     //occurring solely as a consequence of using peer-to-peer transmission
451     //to receive a copy likewise does not require acceptance. However,
452     //nothing other than this License grants you permission to propagate or
453     //modify any covered work. These actions infringe copyright if you do
454     //not accept this License. Therefore, by modifying or propagating a
455     //covered work, you indicate your acceptance of this License to do so.
456     //
457     // 10. Automatic Licensing of Downstream Recipients.
458     //
459     // Each time you convey a covered work, the recipient automatically
460     //receives a license from the original licensors, to run, modify and
461     //propagate that work, subject to this License. You are not responsible
462     //for enforcing compliance by third parties with this License.
463     //
464     // An "entity transaction" is a transaction transferring control of an
465     //organization, or substantially all assets of one, or subdividing an
466     //organization, or merging organizations. If propagation of a covered
467     //work results from an entity transaction, each party to that
468     //transaction who receives a copy of the work also receives whatever
469     //licenses to the work the party's predecessor in interest had or could
470     //give under the previous paragraph, plus a right to possession of the
471     //Corresponding Source of the work from the predecessor in interest, if
472     //the predecessor has it or can get it with reasonable efforts.
473     //
474     // You may not impose any further restrictions on the exercise of the
475     //rights granted or affirmed under this License. For example, you may
476     //not impose a license fee, royalty, or other charge for exercise of
477     //rights granted under this License, and you may not initiate litigation
478     //(including a cross-claim or counterclaim in a lawsuit) alleging that
479     //any patent claim is infringed by making, using, selling, offering for
480     //sale, or importing the Program or any portion of it.
481     //
482     // 11. Patents.
483     //
484     // A "contributor" is a copyright holder who authorizes use under this
485     //License of the Program or a work on which the Program is based. The
486     //work thus licensed is called the contributor's "contributor version".
487     //
488     // A contributor's "essential patent claims" are all patent claims
489     //owned or controlled by the contributor, whether already acquired or
490     //hereafter acquired, that would be infringed by some manner, permitted
491     //by this License, of making, using, or selling its contributor version,
492     //but do not include claims that would be infringed only as a
493     //consequence of further modification of the contributor version. For
494     //purposes of this definition, "control" includes the right to grant
495     //patent sublicenses in a manner consistent with the requirements of
496     //this License.
497     //
498     // Each contributor grants you a non-exclusive, worldwide, royalty-free
499     //patent license under the contributor's essential patent claims, to
500     //make, use, sell, offer for sale, import and otherwise run, modify and
501     //propagate the contents of its contributor version.
502     //
503     // In the following three paragraphs, a "patent license" is any express
504     //agreement or commitment, however denominated, not to enforce a patent
505     //(such as an express permission to practice a patent or covenant not to
506     //sue for patent infringement). To "grant" such a patent license to a
507     //party means to make such an agreement or commitment not to enforce a
508     //patent against the party.
509     //
510     // If you convey a covered work, knowingly relying on a patent license,
511     //and the Corresponding Source of the work is not available for anyone
512     //to copy, free of charge and under the terms of this License, through a
513     //publicly available network server or other readily accessible means,
514     //then you must either (1) cause the Corresponding Source to be so
515     //available, or (2) arrange to deprive yourself of the benefit of the
516     //patent license for this particular work, or (3) arrange, in a manner
517     //consistent with the requirements of this License, to extend the patent
518     //license to downstream recipients. "Knowingly relying" means you have
519     //actual knowledge that, but for the patent license, your conveying the
520     //covered work in a country, or your recipient's use of the covered work
521     //in a country, would infringe one or more identifiable patents in that
522     //country that you have reason to believe are valid.
523     //
524     // If, pursuant to or in connection with a single transaction or
525     //arrangement, you convey, or propagate by procuring conveyance of, a
526     //covered work, and grant a patent license to some of the parties
527     //receiving the covered work authorizing them to use, propagate, modify
528     //or convey a specific copy of the covered work, then the patent license
529     //you grant is automatically extended to all recipients of the covered
530     //work and works based on it.
531     //
532     // A patent license is "discriminatory" if it does not include within
533     //the scope of its coverage, prohibits the exercise of, or is
534     //conditioned on the non-exercise of one or more of the rights that are
535     //specifically granted under this License. You may not convey a covered
536     //work if you are a party to an arrangement with a third party that is
537     //in the business of distributing software, under which you make payment
538     //to the third party based on the extent of your activity of conveying
539     //the work, and under which the third party grants, to any of the
540     //parties who would receive the covered work from you, a discriminatory
541     //patent license (a) in connection with copies of the covered work
542     //conveyed by you (or copies made from those copies), or (b) primarily
543     //for and in connection with specific products or compilations that
544     //contain the covered work, unless you entered into that arrangement,
545     //or that patent license was granted, prior to 28 March 2007.
546     //
547     // Nothing in this License shall be construed as excluding or limiting
548     //any implied license or other defenses to infringement that may
549     //otherwise be available to you under applicable patent law.
550     //
551     // 12. No Surrender of Others' Freedom.
552     //
553     // If conditions are imposed on you (whether by court order, agreement or
554     //otherwise) that contradict the conditions of this License, they do not
555     //excuse you from the conditions of this License. If you cannot convey a
556     //covered work so as to satisfy simultaneously your obligations under this
557     //License and any other pertinent obligations, then as a consequence you may
558     //not convey it at all. For example, if you agree to terms that obligate you
559     //to collect a royalty for further conveying from those to whom you convey
560     //the Program, the only way you could satisfy both those terms and this
561     //License would be to refrain entirely from conveying the Program.
562     //
563     // 13. Use with the GNU Affero General Public License.
564     //
565     // Notwithstanding any other provision of this License, you have
566     //permission to link or combine any covered work with a work licensed
567     //under version 3 of the GNU Affero General Public License into a single
568     //combined work, and to convey the resulting work. The terms of this
569     //License will continue to apply to the part which is the covered work,
570     //but the special requirements of the GNU Affero General Public License,
571     //section 13, concerning interaction through a network will apply to the
572     //combination as such.
573     //
574     // 14. Revised Versions of this License.
575     //
576     // The Free Software Foundation may publish revised and/or new versions of
577     //the GNU General Public License from time to time. Such new versions will
578     //be similar in spirit to the present version, but may differ in detail to
579     //address new problems or concerns.
580     //
581     // Each version is given a distinguishing version number. If the
582     //Program specifies that a certain numbered version of the GNU General
583     //Public License "or any later version" applies to it, you have the
584     //option of following the terms and conditions either of that numbered
585     //version or of any later version published by the Free Software
586     //Foundation. If the Program does not specify a version number of the
587     //GNU General Public License, you may choose any version ever published
588     //by the Free Software Foundation.
589     //
590     // If the Program specifies that a proxy can decide which future
591     //versions of the GNU General Public License can be used, that proxy's
592     //public statement of acceptance of a version permanently authorizes you
593     //to choose that version for the Program.
594     //
595     // Later license versions may give you additional or different
596     //permissions. However, no additional obligations are imposed on any
597     //author or copyright holder as a result of your choosing to follow a
598     //later version.
599     //
600     // 15. Disclaimer of Warranty.
601     //
610     //
611     // 16. Limitation of Liability.
612     //
621     //SUCH DAMAGES.
622     //
623     // 17. Interpretation of Sections 15 and 16.
624     //
625     // If the disclaimer of warranty and limitation of liability provided
626     //above cannot be given local legal effect according to their terms,
627     //reviewing courts shall apply local law that most closely approximates
628     //an absolute waiver of all civil liability in connection with the
629     //Program, unless a warranty or assumption of liability accompanies a
630     //copy of the Program in return for a fee.
631     //
633     //
634     // How to Apply These Terms to Your New Programs
635     //
636     // If you develop a new program, and you want it to be of the greatest
637     //possible use to the public, the best way to achieve this is to make it
638     //free software which everyone can redistribute and change under these terms.
639     //
640     // To do so, attach the following notices to the program. It is safest
641     //to attach them to the start of each source file to most effectively
642     //state the exclusion of warranty; and each file should have at least
643     //the "copyright" line and a pointer to where the full notice is found.
644     //
645     // <one line to give the program's name and a brief idea of what it does.>
646     // Copyright (C) <year> <name of author>
647     //
648     // This program is free software: you can redistribute it and/or modify
649     // it under the terms of the GNU General Public License as published by
650     // the Free Software Foundation, either version 3 of the License, or
651     // (at your option) any later version.
652     //
653     // This program is distributed in the hope that it will be useful,
654     // but WITHOUT ANY WARRANTY; without even the implied warranty of
656     // GNU General Public License for more details.
657     //
658     // You should have received a copy of the GNU General Public License
659     // along with this program. If not, see <http://www.gnu.org/licenses/>.
660     //
661     //Also add information on how to contact you by electronic and paper mail.
662     //
663     // If the program does terminal interaction, make it output a short
664     //notice like this when it starts in an interactive mode:
665     //
666     // <program> Copyright (C) <year> <name of author>
667     // This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
668     // This is free software, and you are welcome to redistribute it
669     // under certain conditions; type `show c' for details.
670     //
671     //The hypothetical commands `show w' and `show c' should show the appropriate
672     //parts of the General Public License. Of course, your program's commands
673     //might be different; for a GUI interface, you would use an "about box".
674     //
675     // You should also get your employer (if you work as a programmer) or school,
676     //if any, to sign a "copyright disclaimer" for the program, if necessary.
677     //For more information on this, and how to apply and follow the GNU GPL, see
678     //<http://www.gnu.org/licenses/>.
679     //
680     // The GNU General Public License does not permit incorporating your program
681     //into proprietary programs. If your program is a subroutine library, you
682     //may consider it more useful to permit linking proprietary applications with
683     //the library. If this is what you want to do, use the GNU Lesser General
684     //Public License instead of this License. But first, please read
685     //<http://www.gnu.org/philosophy/why-not-lgpl.html>.
686     //-------------------------------------------------------------------------------------------------
687     //--------------------------------------------------------------------------------
688     #ifndef CVXZONE_H_INCLUDED
689     #define CVXZONE_H_INCLUDED
691     #ifdef MODULE_CVXZONE
692     #define DECMOD_CVXZONE
693     #else
694     #define DECMOD_CVXZONE extern
695     #endif
697     #define CVXZONE_ZONE_CONST_ALLOC_INC (20)
698     /* The allocation increment for constraints which make up
699     ** a convex zone. This is the number of slots that will
700     ** be allocated at a time. A larger value here creates more
701     ** run-time efficiency but wastes more memory.
702     */
704     /* Types of equalities and inequalities.
705     */
706     #define CVXZONE_INEQ_LT (0) /* < */
707     #define CVXZONE_INEQ_LE (1) /* <= */
708     #define CVXZONE_INEQ_EQ (2) /* == */
709     #define CVXZONE_INEQ_GE (3) /* > */
710     #define CVXZONE_INEQ_GT (4) /* >= */
711     #define CVXZONE_INEQ_UDF (5) /* Unknown or undefined. */
712     #define CVXZONE_INEQ_MAX (6) /* Max for bounds checking. */
715     /* Defines a single constraint, i.e. x[a]-x[b] <|<= K as known
716     ** to this module. x[0] is always the value of zero. Any given
717     ** convex region or zone is a conjunction of such inequalities.
718     */
719     typedef struct
720     {
721     unsigned valid : 1;
722     /* TRUE if record is valid, i.e. used.
723     */
724     unsigned eq : 1;
725     /* TRUE if the inequality is <= rather than
726     ** <.
727     */
728     int v1;
729     int v2;
730     /* Subscripts of variables in v1 - v2 <|<= k.
731     */
732     int k;
733     /* The constant involved.
734     */
735     } CVXZONE_constraint, *CVXZONE_constraint_ptr;
737     /* Fundamental data structure that is a convex zone bounded
738     ** by inequalities. All of the clock variables are represented
739     ** as integers. The variable with index 0 (i.e. x[0]) is the
740     ** special value 0. Therefore, all clocks must be subscripted
741     ** starting with the value "1" and go contiguously upwards, and
742     ** this inconvenience is visible to the client, i.e. the client
743     ** must communicate with this module in these terms.
744     **
745     ** Note that there is some ambiguity in this data structure
746     ** because the order of the space which is being considered
747     ** is not specified anywhere (because there is no need to
748     ** specify it). This module will fatally terminate
749     ** the program in any context where a constraint exists for a variable
750     ** that can't exist (so far there is only one such place this can
751     ** occur). The caller needs to be consistent in the order of the
752     ** space (i.e. the caller needs to know the assumed order of the
753     ** space).
754     */
755     typedef struct
756     {
757     unsigned is_canonical : 1;
758     /* TRUE if the data structure is in canonical form. This
759     ** flag is maintained so that repeated needs to put in
760     ** canonical form will not take any CPU time. Essentially
761     ** any operation that modifies this data structure will
762     ** violate the canonical form and cause this flag to be
763     ** set to 0.
764     */
765     unsigned is_empty : 1;
766     /* By default, a space with no constraints is taken to be
767     ** full, i.e. to contain all of R-space. This flag negates
768     ** that, i.e. signals the empty set. The canonical form
769     ** of all-space is no constraints and this flag FALSE. The
770     ** canonical form of no-space is no constraints and this
771     ** flag TRUE.
772     */
773     unsigned n_allocd;
774     /* The number of slots allocated for constraints in this
775     ** data structure. This value grows, but never shrinks.
776     ** This is the number allocated, but not necessarily the
777     ** number used. This value grows in steps of
778     ** CVXZONE_ZONE_CONST_ALLOC_INC. If this value is zero,
779     ** the pointer below must be NULL.
780     */
781     unsigned n_used;
782     /* The number of slots which are used. This means that the
783     ** used slots range from 0 through this value - 1.
784     ** This only flags the constraints which must be inspected
785     ** and potentially apply, but not necessarily every constraint
786     ** in this range applies. In addition to the constraint being
787     ** subscripted in 0..n-1, the constraint must also have its
788     ** valid bit set. The set of active constraints is thus
789     ** those in the range of 0..n-1 with their valid bits set.
790     */
791     CVXZONE_constraint_ptr constraints;
792     /* Pointer to the allocated block of constraints. The number
793     ** allocated is realloc'd up by CVXZONE_ZONE_CONST_ALLOC_INC
794     ** slots each time one runs out of memory.
795     */
796     } CVXZONE_zone, *CVXZONE_zone_ptr;
798     /**************************************************************************/
800     /**************************************************************************/
801     /* Allocates a new zone and fills in the caller's pointer. The
802     ** pointed-to pointer must be NULL. Zones begin life as "full"--containing
803     ** all of R-space.
804     */
805     DECMOD_CVXZONE void CVXZONE_new(CVXZONE_zone_ptr *arg);
807     /* Deallocates a zone and fills in the caller's pointer to NULL. Previous
808     ** pointer to zone must not be NULL.
809     */
810     DECMOD_CVXZONE void CVXZONE_delete(CVXZONE_zone_ptr *arg);
812     /* Copies one zone to another. The destination zone, which must
813     ** already exist, is overwritten.
814     */
815     DECMOD_CVXZONE void CVXZONE_copy(CVXZONE_zone_ptr *dst, CVXZONE_zone_ptr *src);
817     /* Clones a zone. To clone means to create and copy in one step.
818     */
819     DECMOD_CVXZONE void CVXZONE_clone(CVXZONE_zone_ptr *clone, CVXZONE_zone_ptr *orig);
821     /**************************************************************************/
823     /**************************************************************************/
824     /* Trims extra memory from a zone (but won't convert it to canonical form).
825     ** The default behavior for a zone is that memory is never reclaimed (this is
826     ** probably the desired behavior--reclaiming memory costs time with no real
827     ** benefit). Note that trimming memory goes beyond canonical form ... it is
828     ** not part of making something canonical.
829     */
830     DECMOD_CVXZONE void CVXZONE_maintain_memory_trim(CVXZONE_zone_ptr *arg);
832     /* Converts a zone to canonical form. Normally this type of operation is
833     ** never necessary explicitly, because any function call that needs a zone
834     ** to be in canonical form will ensure this first. This function call
835     ** might never be used except for testing.
836     */
837     DECMOD_CVXZONE void CVXZONE_maintain_canonize(CVXZONE_zone_ptr *arg);
840     /**************************************************************************/
842     /**************************************************************************/
843     /* Assigns a zone, which must already exist, to be the empty set.
844     */
845     DECMOD_CVXZONE void CVXZONE_assign_empty(CVXZONE_zone_ptr *arg);
847     /* Assigns a zone, which must already exist, to be the full set (all of R^N).
848     */
849     DECMOD_CVXZONE void CVXZONE_assign_full(CVXZONE_zone_ptr *arg);
852     /**************************************************************************/
853     /***** TEST FUNCTIONS
854     /**************************************************************************/
855     /* Set testing functions. In general these functions may modify even
856     ** operands that are not identified as outputs, because it may be necessary
857     ** to convert sets to canonical form before operations can be performed.
858     ** However, the sets will not be modified so as to change their logical
859     ** value.
860     */
861     /* Tests whether a zone is empty. Returns TRUE if empty.
862     */
863     DECMOD_CVXZONE int CVXZONE_test_empty(CVXZONE_zone_ptr *arg);
865     /* Tests whether a zone is full. Returns TRUE if full. "Full" means covers all of
866     ** N-dimensional space.
867     */
868     DECMOD_CVXZONE int CVXZONE_test_full(CVXZONE_zone_ptr *arg);
870     /* Tests whether one set is equal to another. Returns TRUE if equal.
871     */
872     DECMOD_CVXZONE int CVXZONE_test_proper_equal(CVXZONE_zone_ptr *set1,
873     CVXZONE_zone_ptr *set2);
875     /* Tests whether a point belongs to a set. The point is specified as
876     ** an integer array, with n entries, giving the successive coordinates.
877     ** Element [0] is ignored, and element [1] is the value of x_1, element
878     ** [2] is the value of x_2, etc. Specifying too many coordinates will
879     ** not be detected, as there will be simply no constraints on those
880     ** coordinates and so the extra coordinates will effectively being ignored.
881     ** Specifying too few coordinates may or may not be detected. If a
882     ** constraint is detected which cannot be applied, this will fatally
883     ** terminate the program.
884     */
885     DECMOD_CVXZONE int CVXZONE_test_point_membership(CVXZONE_zone_ptr *base_set,
886     int n_coords,
887     int *coords);
889     /* Tests whether one set is a proper subset of another. Returns TRUE if
890     ** it is.
891     */
892     DECMOD_CVXZONE int CVXZONE_test_proper_subset(CVXZONE_zone_ptr *base_set,
893     CVXZONE_zone_ptr *potential_subset);
895     /* Tests whether one set is an improper subset of another. Returns TRUE if
896     ** it is. An improper subset is just like a subset, but equality is allowed.
897     */
898     DECMOD_CVXZONE int CVXZONE_test_improper_subset(CVXZONE_zone_ptr *base_set,
899     CVXZONE_zone_ptr *potential_subset);
901     /**************************************************************************/
903     /**************************************************************************/
904     /* Adds a constraint to a set. The constraint is of the form
905     ** arg1 - arg2 <|<= k. A variable with index 0 is a special case,
906     ** and this is treated as zero (i.e. it is a fictional variable).
907     ** The "eq" flag makes the difference between "<" and "<=". If "eq" is
908     ** TRUE, then "<=" is assumed.
909     **
910     ** The set is the intersection of all the half-[hyper]regions formed by the
911     ** constraints. Note that forming a set by repeatedly adding constraints
912     ** only works if set used to start is the "full" set. Adding any constraints
913     ** to an empty set will only result in an empty set that will be cleaned up the
914     ** next time it is canonized.
915     */
916     DECMOD_CVXZONE void CVXZONE_modify_add_constraint(CVXZONE_zone_ptr *base_set,
917     int arg1_idx,
918     int arg2_idx,
919     int eq,
920     int k);
923     /**************************************************************************/
925     /**************************************************************************/
926     /* Calculates the intersection of two sets and assigns it to a third set, which
927     ** must exist. (BTW, note that union cannot be calculated in this framework,
928     ** because it might result in a set which is not convex. That is why no unioning
929     ** function is provided here.)
930     */
931     DECMOD_CVXZONE void CVXZONE_calculate_intersection(CVXZONE_zone_ptr *dst,
932     CVXZONE_zone_ptr *src1,
933     CVXZONE_zone_ptr *src2);
935     #endif
937     /***************************************************************************
938     ** $Log: cvxzone.h,v $
939     ** Revision 1.4 2001/10/25 05:33:05 dtashley
940     ** Evening safety checkin after edits.
941     **
942     ** Revision 1.3 2001/10/19 21:28:10 dtashley
943     ** Safety save before weekend.
944     **
945     ** Revision 1.2 2001/10/18 20:39:25 dtashley
946     ** Substantial edits.
947     **
948     ** Revision 1.1 2001/10/18 17:19:03 dtashley
949     ** Initial checkin.
950     ****************************************************************************
951     ** End of CVXZONE.H. */

ViewVC Help
Powered by ViewVC 1.1.25