/[dtapublic]/projs/trunk/shared_source/c_datd/gmp_rats.c
ViewVC logotype

Annotation of /projs/trunk/shared_source/c_datd/gmp_rats.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 25 - (hide annotations) (download)
Sat Oct 8 06:43:03 2016 UTC (7 years, 9 months ago) by dashley
Original Path: sf_code/esrgpcpj/shared/c_datd/gmp_rats.c
File MIME type: text/plain
File size: 70698 byte(s)
Initial commit.
1 dashley 25 // $Header: /cvsroot/esrg/sfesrg/esrgpcpj/shared/c_datd/gmp_rats.c,v 1.10 2001/08/16 19:49:40 dtashley Exp $
2    
3     //--------------------------------------------------------------------------------
4     //Copyright 2001 David T. Ashley
5     //-------------------------------------------------------------------------------------------------
6     //This source code and any program in which it is compiled/used is provided under the GNU GENERAL
7     //PUBLIC LICENSE, Version 3, full license text below.
8     //-------------------------------------------------------------------------------------------------
9     // GNU GENERAL PUBLIC LICENSE
10     // Version 3, 29 June 2007
11     //
12     // Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
13     // Everyone is permitted to copy and distribute verbatim copies
14     // of this license document, but changing it is not allowed.
15     //
16     // Preamble
17     //
18     // The GNU General Public License is a free, copyleft license for
19     //software and other kinds of works.
20     //
21     // The licenses for most software and other practical works are designed
22     //to take away your freedom to share and change the works. By contrast,
23     //the GNU General Public License is intended to guarantee your freedom to
24     //share and change all versions of a program--to make sure it remains free
25     //software for all its users. We, the Free Software Foundation, use the
26     //GNU General Public License for most of our software; it applies also to
27     //any other work released this way by its authors. You can apply it to
28     //your programs, too.
29     //
30     // When we speak of free software, we are referring to freedom, not
31     //price. Our General Public Licenses are designed to make sure that you
32     //have the freedom to distribute copies of free software (and charge for
33     //them if you wish), that you receive source code or can get it if you
34     //want it, that you can change the software or use pieces of it in new
35     //free programs, and that you know you can do these things.
36     //
37     // To protect your rights, we need to prevent others from denying you
38     //these rights or asking you to surrender the rights. Therefore, you have
39     //certain responsibilities if you distribute copies of the software, or if
40     //you modify it: responsibilities to respect the freedom of others.
41     //
42     // For example, if you distribute copies of such a program, whether
43     //gratis or for a fee, you must pass on to the recipients the same
44     //freedoms that you received. You must make sure that they, too, receive
45     //or can get the source code. And you must show them these terms so they
46     //know their rights.
47     //
48     // Developers that use the GNU GPL protect your rights with two steps:
49     //(1) assert copyright on the software, and (2) offer you this License
50     //giving you legal permission to copy, distribute and/or modify it.
51     //
52     // For the developers' and authors' protection, the GPL clearly explains
53     //that there is no warranty for this free software. For both users' and
54     //authors' sake, the GPL requires that modified versions be marked as
55     //changed, so that their problems will not be attributed erroneously to
56     //authors of previous versions.
57     //
58     // Some devices are designed to deny users access to install or run
59     //modified versions of the software inside them, although the manufacturer
60     //can do so. This is fundamentally incompatible with the aim of
61     //protecting users' freedom to change the software. The systematic
62     //pattern of such abuse occurs in the area of products for individuals to
63     //use, which is precisely where it is most unacceptable. Therefore, we
64     //have designed this version of the GPL to prohibit the practice for those
65     //products. If such problems arise substantially in other domains, we
66     //stand ready to extend this provision to those domains in future versions
67     //of the GPL, as needed to protect the freedom of users.
68     //
69     // Finally, every program is threatened constantly by software patents.
70     //States should not allow patents to restrict development and use of
71     //software on general-purpose computers, but in those that do, we wish to
72     //avoid the special danger that patents applied to a free program could
73     //make it effectively proprietary. To prevent this, the GPL assures that
74     //patents cannot be used to render the program non-free.
75     //
76     // The precise terms and conditions for copying, distribution and
77     //modification follow.
78     //
79     // TERMS AND CONDITIONS
80     //
81     // 0. Definitions.
82     //
83     // "This License" refers to version 3 of the GNU General Public License.
84     //
85     // "Copyright" also means copyright-like laws that apply to other kinds of
86     //works, such as semiconductor masks.
87     //
88     // "The Program" refers to any copyrightable work licensed under this
89     //License. Each licensee is addressed as "you". "Licensees" and
90     //"recipients" may be individuals or organizations.
91     //
92     // To "modify" a work means to copy from or adapt all or part of the work
93     //in a fashion requiring copyright permission, other than the making of an
94     //exact copy. The resulting work is called a "modified version" of the
95     //earlier work or a work "based on" the earlier work.
96     //
97     // A "covered work" means either the unmodified Program or a work based
98     //on the Program.
99     //
100     // To "propagate" a work means to do anything with it that, without
101     //permission, would make you directly or secondarily liable for
102     //infringement under applicable copyright law, except executing it on a
103     //computer or modifying a private copy. Propagation includes copying,
104     //distribution (with or without modification), making available to the
105     //public, and in some countries other activities as well.
106     //
107     // To "convey" a work means any kind of propagation that enables other
108     //parties to make or receive copies. Mere interaction with a user through
109     //a computer network, with no transfer of a copy, is not conveying.
110     //
111     // An interactive user interface displays "Appropriate Legal Notices"
112     //to the extent that it includes a convenient and prominently visible
113     //feature that (1) displays an appropriate copyright notice, and (2)
114     //tells the user that there is no warranty for the work (except to the
115     //extent that warranties are provided), that licensees may convey the
116     //work under this License, and how to view a copy of this License. If
117     //the interface presents a list of user commands or options, such as a
118     //menu, a prominent item in the list meets this criterion.
119     //
120     // 1. Source Code.
121     //
122     // The "source code" for a work means the preferred form of the work
123     //for making modifications to it. "Object code" means any non-source
124     //form of a work.
125     //
126     // A "Standard Interface" means an interface that either is an official
127     //standard defined by a recognized standards body, or, in the case of
128     //interfaces specified for a particular programming language, one that
129     //is widely used among developers working in that language.
130     //
131     // The "System Libraries" of an executable work include anything, other
132     //than the work as a whole, that (a) is included in the normal form of
133     //packaging a Major Component, but which is not part of that Major
134     //Component, and (b) serves only to enable use of the work with that
135     //Major Component, or to implement a Standard Interface for which an
136     //implementation is available to the public in source code form. A
137     //"Major Component", in this context, means a major essential component
138     //(kernel, window system, and so on) of the specific operating system
139     //(if any) on which the executable work runs, or a compiler used to
140     //produce the work, or an object code interpreter used to run it.
141     //
142     // The "Corresponding Source" for a work in object code form means all
143     //the source code needed to generate, install, and (for an executable
144     //work) run the object code and to modify the work, including scripts to
145     //control those activities. However, it does not include the work's
146     //System Libraries, or general-purpose tools or generally available free
147     //programs which are used unmodified in performing those activities but
148     //which are not part of the work. For example, Corresponding Source
149     //includes interface definition files associated with source files for
150     //the work, and the source code for shared libraries and dynamically
151     //linked subprograms that the work is specifically designed to require,
152     //such as by intimate data communication or control flow between those
153     //subprograms and other parts of the work.
154     //
155     // The Corresponding Source need not include anything that users
156     //can regenerate automatically from other parts of the Corresponding
157     //Source.
158     //
159     // The Corresponding Source for a work in source code form is that
160     //same work.
161     //
162     // 2. Basic Permissions.
163     //
164     // All rights granted under this License are granted for the term of
165     //copyright on the Program, and are irrevocable provided the stated
166     //conditions are met. This License explicitly affirms your unlimited
167     //permission to run the unmodified Program. The output from running a
168     //covered work is covered by this License only if the output, given its
169     //content, constitutes a covered work. This License acknowledges your
170     //rights of fair use or other equivalent, as provided by copyright law.
171     //
172     // You may make, run and propagate covered works that you do not
173     //convey, without conditions so long as your license otherwise remains
174     //in force. You may convey covered works to others for the sole purpose
175     //of having them make modifications exclusively for you, or provide you
176     //with facilities for running those works, provided that you comply with
177     //the terms of this License in conveying all material for which you do
178     //not control copyright. Those thus making or running the covered works
179     //for you must do so exclusively on your behalf, under your direction
180     //and control, on terms that prohibit them from making any copies of
181     //your copyrighted material outside their relationship with you.
182     //
183     // Conveying under any other circumstances is permitted solely under
184     //the conditions stated below. Sublicensing is not allowed; section 10
185     //makes it unnecessary.
186     //
187     // 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
188     //
189     // No covered work shall be deemed part of an effective technological
190     //measure under any applicable law fulfilling obligations under article
191     //11 of the WIPO copyright treaty adopted on 20 December 1996, or
192     //similar laws prohibiting or restricting circumvention of such
193     //measures.
194     //
195     // When you convey a covered work, you waive any legal power to forbid
196     //circumvention of technological measures to the extent such circumvention
197     //is effected by exercising rights under this License with respect to
198     //the covered work, and you disclaim any intention to limit operation or
199     //modification of the work as a means of enforcing, against the work's
200     //users, your or third parties' legal rights to forbid circumvention of
201     //technological measures.
202     //
203     // 4. Conveying Verbatim Copies.
204     //
205     // You may convey verbatim copies of the Program's source code as you
206     //receive it, in any medium, provided that you conspicuously and
207     //appropriately publish on each copy an appropriate copyright notice;
208     //keep intact all notices stating that this License and any
209     //non-permissive terms added in accord with section 7 apply to the code;
210     //keep intact all notices of the absence of any warranty; and give all
211     //recipients a copy of this License along with the Program.
212     //
213     // You may charge any price or no price for each copy that you convey,
214     //and you may offer support or warranty protection for a fee.
215     //
216     // 5. Conveying Modified Source Versions.
217     //
218     // You may convey a work based on the Program, or the modifications to
219     //produce it from the Program, in the form of source code under the
220     //terms of section 4, provided that you also meet all of these conditions:
221     //
222     // a) The work must carry prominent notices stating that you modified
223     // it, and giving a relevant date.
224     //
225     // b) The work must carry prominent notices stating that it is
226     // released under this License and any conditions added under section
227     // 7. This requirement modifies the requirement in section 4 to
228     // "keep intact all notices".
229     //
230     // c) You must license the entire work, as a whole, under this
231     // License to anyone who comes into possession of a copy. This
232     // License will therefore apply, along with any applicable section 7
233     // additional terms, to the whole of the work, and all its parts,
234     // regardless of how they are packaged. This License gives no
235     // permission to license the work in any other way, but it does not
236     // invalidate such permission if you have separately received it.
237     //
238     // d) If the work has interactive user interfaces, each must display
239     // Appropriate Legal Notices; however, if the Program has interactive
240     // interfaces that do not display Appropriate Legal Notices, your
241     // work need not make them do so.
242     //
243     // A compilation of a covered work with other separate and independent
244     //works, which are not by their nature extensions of the covered work,
245     //and which are not combined with it such as to form a larger program,
246     //in or on a volume of a storage or distribution medium, is called an
247     //"aggregate" if the compilation and its resulting copyright are not
248     //used to limit the access or legal rights of the compilation's users
249     //beyond what the individual works permit. Inclusion of a covered work
250     //in an aggregate does not cause this License to apply to the other
251     //parts of the aggregate.
252     //
253     // 6. Conveying Non-Source Forms.
254     //
255     // You may convey a covered work in object code form under the terms
256     //of sections 4 and 5, provided that you also convey the
257     //machine-readable Corresponding Source under the terms of this License,
258     //in one of these ways:
259     //
260     // a) Convey the object code in, or embodied in, a physical product
261     // (including a physical distribution medium), accompanied by the
262     // Corresponding Source fixed on a durable physical medium
263     // customarily used for software interchange.
264     //
265     // b) Convey the object code in, or embodied in, a physical product
266     // (including a physical distribution medium), accompanied by a
267     // written offer, valid for at least three years and valid for as
268     // long as you offer spare parts or customer support for that product
269     // model, to give anyone who possesses the object code either (1) a
270     // copy of the Corresponding Source for all the software in the
271     // product that is covered by this License, on a durable physical
272     // medium customarily used for software interchange, for a price no
273     // more than your reasonable cost of physically performing this
274     // conveying of source, or (2) access to copy the
275     // Corresponding Source from a network server at no charge.
276     //
277     // c) Convey individual copies of the object code with a copy of the
278     // written offer to provide the Corresponding Source. This
279     // alternative is allowed only occasionally and noncommercially, and
280     // only if you received the object code with such an offer, in accord
281     // with subsection 6b.
282     //
283     // d) Convey the object code by offering access from a designated
284     // place (gratis or for a charge), and offer equivalent access to the
285     // Corresponding Source in the same way through the same place at no
286     // further charge. You need not require recipients to copy the
287     // Corresponding Source along with the object code. If the place to
288     // copy the object code is a network server, the Corresponding Source
289     // may be on a different server (operated by you or a third party)
290     // that supports equivalent copying facilities, provided you maintain
291     // clear directions next to the object code saying where to find the
292     // Corresponding Source. Regardless of what server hosts the
293     // Corresponding Source, you remain obligated to ensure that it is
294     // available for as long as needed to satisfy these requirements.
295     //
296     // e) Convey the object code using peer-to-peer transmission, provided
297     // you inform other peers where the object code and Corresponding
298     // Source of the work are being offered to the general public at no
299     // charge under subsection 6d.
300     //
301     // A separable portion of the object code, whose source code is excluded
302     //from the Corresponding Source as a System Library, need not be
303     //included in conveying the object code work.
304     //
305     // A "User Product" is either (1) a "consumer product", which means any
306     //tangible personal property which is normally used for personal, family,
307     //or household purposes, or (2) anything designed or sold for incorporation
308     //into a dwelling. In determining whether a product is a consumer product,
309     //doubtful cases shall be resolved in favor of coverage. For a particular
310     //product received by a particular user, "normally used" refers to a
311     //typical or common use of that class of product, regardless of the status
312     //of the particular user or of the way in which the particular user
313     //actually uses, or expects or is expected to use, the product. A product
314     //is a consumer product regardless of whether the product has substantial
315     //commercial, industrial or non-consumer uses, unless such uses represent
316     //the only significant mode of use of the product.
317     //
318     // "Installation Information" for a User Product means any methods,
319     //procedures, authorization keys, or other information required to install
320     //and execute modified versions of a covered work in that User Product from
321     //a modified version of its Corresponding Source. The information must
322     //suffice to ensure that the continued functioning of the modified object
323     //code is in no case prevented or interfered with solely because
324     //modification has been made.
325     //
326     // If you convey an object code work under this section in, or with, or
327     //specifically for use in, a User Product, and the conveying occurs as
328     //part of a transaction in which the right of possession and use of the
329     //User Product is transferred to the recipient in perpetuity or for a
330     //fixed term (regardless of how the transaction is characterized), the
331     //Corresponding Source conveyed under this section must be accompanied
332     //by the Installation Information. But this requirement does not apply
333     //if neither you nor any third party retains the ability to install
334     //modified object code on the User Product (for example, the work has
335     //been installed in ROM).
336     //
337     // The requirement to provide Installation Information does not include a
338     //requirement to continue to provide support service, warranty, or updates
339     //for a work that has been modified or installed by the recipient, or for
340     //the User Product in which it has been modified or installed. Access to a
341     //network may be denied when the modification itself materially and
342     //adversely affects the operation of the network or violates the rules and
343     //protocols for communication across the network.
344     //
345     // Corresponding Source conveyed, and Installation Information provided,
346     //in accord with this section must be in a format that is publicly
347     //documented (and with an implementation available to the public in
348     //source code form), and must require no special password or key for
349     //unpacking, reading or copying.
350     //
351     // 7. Additional Terms.
352     //
353     // "Additional permissions" are terms that supplement the terms of this
354     //License by making exceptions from one or more of its conditions.
355     //Additional permissions that are applicable to the entire Program shall
356     //be treated as though they were included in this License, to the extent
357     //that they are valid under applicable law. If additional permissions
358     //apply only to part of the Program, that part may be used separately
359     //under those permissions, but the entire Program remains governed by
360     //this License without regard to the additional permissions.
361     //
362     // When you convey a copy of a covered work, you may at your option
363     //remove any additional permissions from that copy, or from any part of
364     //it. (Additional permissions may be written to require their own
365     //removal in certain cases when you modify the work.) You may place
366     //additional permissions on material, added by you to a covered work,
367     //for which you have or can give appropriate copyright permission.
368     //
369     // Notwithstanding any other provision of this License, for material you
370     //add to a covered work, you may (if authorized by the copyright holders of
371     //that material) supplement the terms of this License with terms:
372     //
373     // a) Disclaiming warranty or limiting liability differently from the
374     // terms of sections 15 and 16 of this License; or
375     //
376     // b) Requiring preservation of specified reasonable legal notices or
377     // author attributions in that material or in the Appropriate Legal
378     // Notices displayed by works containing it; or
379     //
380     // c) Prohibiting misrepresentation of the origin of that material, or
381     // requiring that modified versions of such material be marked in
382     // reasonable ways as different from the original version; or
383     //
384     // d) Limiting the use for publicity purposes of names of licensors or
385     // authors of the material; or
386     //
387     // e) Declining to grant rights under trademark law for use of some
388     // trade names, trademarks, or service marks; or
389     //
390     // f) Requiring indemnification of licensors and authors of that
391     // material by anyone who conveys the material (or modified versions of
392     // it) with contractual assumptions of liability to the recipient, for
393     // any liability that these contractual assumptions directly impose on
394     // those licensors and authors.
395     //
396     // All other non-permissive additional terms are considered "further
397     //restrictions" within the meaning of section 10. If the Program as you
398     //received it, or any part of it, contains a notice stating that it is
399     //governed by this License along with a term that is a further
400     //restriction, you may remove that term. If a license document contains
401     //a further restriction but permits relicensing or conveying under this
402     //License, you may add to a covered work material governed by the terms
403     //of that license document, provided that the further restriction does
404     //not survive such relicensing or conveying.
405     //
406     // If you add terms to a covered work in accord with this section, you
407     //must place, in the relevant source files, a statement of the
408     //additional terms that apply to those files, or a notice indicating
409     //where to find the applicable terms.
410     //
411     // Additional terms, permissive or non-permissive, may be stated in the
412     //form of a separately written license, or stated as exceptions;
413     //the above requirements apply either way.
414     //
415     // 8. Termination.
416     //
417     // You may not propagate or modify a covered work except as expressly
418     //provided under this License. Any attempt otherwise to propagate or
419     //modify it is void, and will automatically terminate your rights under
420     //this License (including any patent licenses granted under the third
421     //paragraph of section 11).
422     //
423     // However, if you cease all violation of this License, then your
424     //license from a particular copyright holder is reinstated (a)
425     //provisionally, unless and until the copyright holder explicitly and
426     //finally terminates your license, and (b) permanently, if the copyright
427     //holder fails to notify you of the violation by some reasonable means
428     //prior to 60 days after the cessation.
429     //
430     // Moreover, your license from a particular copyright holder is
431     //reinstated permanently if the copyright holder notifies you of the
432     //violation by some reasonable means, this is the first time you have
433     //received notice of violation of this License (for any work) from that
434     //copyright holder, and you cure the violation prior to 30 days after
435     //your receipt of the notice.
436     //
437     // Termination of your rights under this section does not terminate the
438     //licenses of parties who have received copies or rights from you under
439     //this License. If your rights have been terminated and not permanently
440     //reinstated, you do not qualify to receive new licenses for the same
441     //material under section 10.
442     //
443     // 9. Acceptance Not Required for Having Copies.
444     //
445     // You are not required to accept this License in order to receive or
446     //run a copy of the Program. Ancillary propagation of a covered work
447     //occurring solely as a consequence of using peer-to-peer transmission
448     //to receive a copy likewise does not require acceptance. However,
449     //nothing other than this License grants you permission to propagate or
450     //modify any covered work. These actions infringe copyright if you do
451     //not accept this License. Therefore, by modifying or propagating a
452     //covered work, you indicate your acceptance of this License to do so.
453     //
454     // 10. Automatic Licensing of Downstream Recipients.
455     //
456     // Each time you convey a covered work, the recipient automatically
457     //receives a license from the original licensors, to run, modify and
458     //propagate that work, subject to this License. You are not responsible
459     //for enforcing compliance by third parties with this License.
460     //
461     // An "entity transaction" is a transaction transferring control of an
462     //organization, or substantially all assets of one, or subdividing an
463     //organization, or merging organizations. If propagation of a covered
464     //work results from an entity transaction, each party to that
465     //transaction who receives a copy of the work also receives whatever
466     //licenses to the work the party's predecessor in interest had or could
467     //give under the previous paragraph, plus a right to possession of the
468     //Corresponding Source of the work from the predecessor in interest, if
469     //the predecessor has it or can get it with reasonable efforts.
470     //
471     // You may not impose any further restrictions on the exercise of the
472     //rights granted or affirmed under this License. For example, you may
473     //not impose a license fee, royalty, or other charge for exercise of
474     //rights granted under this License, and you may not initiate litigation
475     //(including a cross-claim or counterclaim in a lawsuit) alleging that
476     //any patent claim is infringed by making, using, selling, offering for
477     //sale, or importing the Program or any portion of it.
478     //
479     // 11. Patents.
480     //
481     // A "contributor" is a copyright holder who authorizes use under this
482     //License of the Program or a work on which the Program is based. The
483     //work thus licensed is called the contributor's "contributor version".
484     //
485     // A contributor's "essential patent claims" are all patent claims
486     //owned or controlled by the contributor, whether already acquired or
487     //hereafter acquired, that would be infringed by some manner, permitted
488     //by this License, of making, using, or selling its contributor version,
489     //but do not include claims that would be infringed only as a
490     //consequence of further modification of the contributor version. For
491     //purposes of this definition, "control" includes the right to grant
492     //patent sublicenses in a manner consistent with the requirements of
493     //this License.
494     //
495     // Each contributor grants you a non-exclusive, worldwide, royalty-free
496     //patent license under the contributor's essential patent claims, to
497     //make, use, sell, offer for sale, import and otherwise run, modify and
498     //propagate the contents of its contributor version.
499     //
500     // In the following three paragraphs, a "patent license" is any express
501     //agreement or commitment, however denominated, not to enforce a patent
502     //(such as an express permission to practice a patent or covenant not to
503     //sue for patent infringement). To "grant" such a patent license to a
504     //party means to make such an agreement or commitment not to enforce a
505     //patent against the party.
506     //
507     // If you convey a covered work, knowingly relying on a patent license,
508     //and the Corresponding Source of the work is not available for anyone
509     //to copy, free of charge and under the terms of this License, through a
510     //publicly available network server or other readily accessible means,
511     //then you must either (1) cause the Corresponding Source to be so
512     //available, or (2) arrange to deprive yourself of the benefit of the
513     //patent license for this particular work, or (3) arrange, in a manner
514     //consistent with the requirements of this License, to extend the patent
515     //license to downstream recipients. "Knowingly relying" means you have
516     //actual knowledge that, but for the patent license, your conveying the
517     //covered work in a country, or your recipient's use of the covered work
518     //in a country, would infringe one or more identifiable patents in that
519     //country that you have reason to believe are valid.
520     //
521     // If, pursuant to or in connection with a single transaction or
522     //arrangement, you convey, or propagate by procuring conveyance of, a
523     //covered work, and grant a patent license to some of the parties
524     //receiving the covered work authorizing them to use, propagate, modify
525     //or convey a specific copy of the covered work, then the patent license
526     //you grant is automatically extended to all recipients of the covered
527     //work and works based on it.
528     //
529     // A patent license is "discriminatory" if it does not include within
530     //the scope of its coverage, prohibits the exercise of, or is
531     //conditioned on the non-exercise of one or more of the rights that are
532     //specifically granted under this License. You may not convey a covered
533     //work if you are a party to an arrangement with a third party that is
534     //in the business of distributing software, under which you make payment
535     //to the third party based on the extent of your activity of conveying
536     //the work, and under which the third party grants, to any of the
537     //parties who would receive the covered work from you, a discriminatory
538     //patent license (a) in connection with copies of the covered work
539     //conveyed by you (or copies made from those copies), or (b) primarily
540     //for and in connection with specific products or compilations that
541     //contain the covered work, unless you entered into that arrangement,
542     //or that patent license was granted, prior to 28 March 2007.
543     //
544     // Nothing in this License shall be construed as excluding or limiting
545     //any implied license or other defenses to infringement that may
546     //otherwise be available to you under applicable patent law.
547     //
548     // 12. No Surrender of Others' Freedom.
549     //
550     // If conditions are imposed on you (whether by court order, agreement or
551     //otherwise) that contradict the conditions of this License, they do not
552     //excuse you from the conditions of this License. If you cannot convey a
553     //covered work so as to satisfy simultaneously your obligations under this
554     //License and any other pertinent obligations, then as a consequence you may
555     //not convey it at all. For example, if you agree to terms that obligate you
556     //to collect a royalty for further conveying from those to whom you convey
557     //the Program, the only way you could satisfy both those terms and this
558     //License would be to refrain entirely from conveying the Program.
559     //
560     // 13. Use with the GNU Affero General Public License.
561     //
562     // Notwithstanding any other provision of this License, you have
563     //permission to link or combine any covered work with a work licensed
564     //under version 3 of the GNU Affero General Public License into a single
565     //combined work, and to convey the resulting work. The terms of this
566     //License will continue to apply to the part which is the covered work,
567     //but the special requirements of the GNU Affero General Public License,
568     //section 13, concerning interaction through a network will apply to the
569     //combination as such.
570     //
571     // 14. Revised Versions of this License.
572     //
573     // The Free Software Foundation may publish revised and/or new versions of
574     //the GNU General Public License from time to time. Such new versions will
575     //be similar in spirit to the present version, but may differ in detail to
576     //address new problems or concerns.
577     //
578     // Each version is given a distinguishing version number. If the
579     //Program specifies that a certain numbered version of the GNU General
580     //Public License "or any later version" applies to it, you have the
581     //option of following the terms and conditions either of that numbered
582     //version or of any later version published by the Free Software
583     //Foundation. If the Program does not specify a version number of the
584     //GNU General Public License, you may choose any version ever published
585     //by the Free Software Foundation.
586     //
587     // If the Program specifies that a proxy can decide which future
588     //versions of the GNU General Public License can be used, that proxy's
589     //public statement of acceptance of a version permanently authorizes you
590     //to choose that version for the Program.
591     //
592     // Later license versions may give you additional or different
593     //permissions. However, no additional obligations are imposed on any
594     //author or copyright holder as a result of your choosing to follow a
595     //later version.
596     //
597     // 15. Disclaimer of Warranty.
598     //
599     // THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
600     //APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
601     //HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
602     //OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
603     //THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
604     //PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
605     //IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
606     //ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
607     //
608     // 16. Limitation of Liability.
609     //
610     // IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
611     //WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
612     //THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
613     //GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
614     //USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
615     //DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
616     //PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
617     //EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
618     //SUCH DAMAGES.
619     //
620     // 17. Interpretation of Sections 15 and 16.
621     //
622     // If the disclaimer of warranty and limitation of liability provided
623     //above cannot be given local legal effect according to their terms,
624     //reviewing courts shall apply local law that most closely approximates
625     //an absolute waiver of all civil liability in connection with the
626     //Program, unless a warranty or assumption of liability accompanies a
627     //copy of the Program in return for a fee.
628     //
629     // END OF TERMS AND CONDITIONS
630     //
631     // How to Apply These Terms to Your New Programs
632     //
633     // If you develop a new program, and you want it to be of the greatest
634     //possible use to the public, the best way to achieve this is to make it
635     //free software which everyone can redistribute and change under these terms.
636     //
637     // To do so, attach the following notices to the program. It is safest
638     //to attach them to the start of each source file to most effectively
639     //state the exclusion of warranty; and each file should have at least
640     //the "copyright" line and a pointer to where the full notice is found.
641     //
642     // <one line to give the program's name and a brief idea of what it does.>
643     // Copyright (C) <year> <name of author>
644     //
645     // This program is free software: you can redistribute it and/or modify
646     // it under the terms of the GNU General Public License as published by
647     // the Free Software Foundation, either version 3 of the License, or
648     // (at your option) any later version.
649     //
650     // This program is distributed in the hope that it will be useful,
651     // but WITHOUT ANY WARRANTY; without even the implied warranty of
652     // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
653     // GNU General Public License for more details.
654     //
655     // You should have received a copy of the GNU General Public License
656     // along with this program. If not, see <http://www.gnu.org/licenses/>.
657     //
658     //Also add information on how to contact you by electronic and paper mail.
659     //
660     // If the program does terminal interaction, make it output a short
661     //notice like this when it starts in an interactive mode:
662     //
663     // <program> Copyright (C) <year> <name of author>
664     // This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
665     // This is free software, and you are welcome to redistribute it
666     // under certain conditions; type `show c' for details.
667     //
668     //The hypothetical commands `show w' and `show c' should show the appropriate
669     //parts of the General Public License. Of course, your program's commands
670     //might be different; for a GUI interface, you would use an "about box".
671     //
672     // You should also get your employer (if you work as a programmer) or school,
673     //if any, to sign a "copyright disclaimer" for the program, if necessary.
674     //For more information on this, and how to apply and follow the GNU GPL, see
675     //<http://www.gnu.org/licenses/>.
676     //
677     // The GNU General Public License does not permit incorporating your program
678     //into proprietary programs. If your program is a subroutine library, you
679     //may consider it more useful to permit linking proprietary applications with
680     //the library. If this is what you want to do, use the GNU Lesser General
681     //Public License instead of this License. But first, please read
682     //<http://www.gnu.org/philosophy/why-not-lgpl.html>.
683     //-------------------------------------------------------------------------------------------------
684     //--------------------------------------------------------------------------------
685     #define MODULE_GMP_RATS
686    
687     #include <assert.h>
688     #include <stdio.h>
689     #include <string.h>
690    
691     #include "bstrfunc.h"
692     #include "charfunc.h"
693     #include "gmp_ints.h"
694     #include "gmp_rats.h"
695    
696     #if defined(APP_TYPE_SIMPLE_DOS_CONSOLE)
697     #include "ccmalloc.h"
698     #elif defined(APP_TYPE_IJUSCRIPTER_IJUCONSOLE)
699     #include "tclalloc.h"
700     #else
701     #include <malloc.h>
702     #endif
703    
704    
705     /******************************************************************/
706     /*** STATUS FUNCTIONS *******************************************/
707     /******************************************************************/
708     //Functions in this category provide information about rational
709     //numbers.
710     //08/08/01: Visual inspection OK.
711     int GMP_RATS_mpq_is_nan(const GMP_RATS_mpq_struct *rn)
712     {
713     assert(rn != NULL);
714    
715     //A rational number is NAN in one of two
716     //circumstances. If either of the integer components
717     //is NAN, or else if there is a zero denominator.
718     if (GMP_INTS_mpz_get_flags(&(rn->num)) || GMP_INTS_mpz_get_flags(&(rn->den)))
719     {
720     return(1);
721     }
722     if (GMP_INTS_mpz_is_zero(&(rn->den)))
723     {
724     return(1);
725     }
726    
727     //We're clean ...
728     return(0);
729     }
730    
731    
732     /******************************************************************/
733     /*** INITIALIZATION, CLEARING, AND SETTING FUNCTIONS ************/
734     /******************************************************************/
735     //08/07/01: Visual inspection OK.
736     void GMP_RATS_mpq_init(GMP_RATS_mpq_struct *arg)
737     {
738     //Eyeball the input parameter.
739     assert(arg != NULL);
740    
741     //Initialize the numerator and denominator.
742     GMP_INTS_mpz_init(&(arg->num));
743     GMP_INTS_mpz_init(&(arg->den));
744    
745     //Canonically, we must start off as 0/1--canonical zero.
746     GMP_INTS_mpz_set_ui(&(arg->num), 0);
747     GMP_INTS_mpz_set_ui(&(arg->den), 1);
748     }
749    
750    
751     //08/07/01: Visual inspection OK.
752     void GMP_RATS_mpq_clear(GMP_RATS_mpq_struct *arg)
753     {
754     //Eyeball the input parameter.
755     assert(arg != NULL);
756    
757     //Clear the numerator and denominator. The called functions
758     //will check for NULL pointers and so forth.
759     GMP_INTS_mpz_clear(&(arg->num));
760     GMP_INTS_mpz_clear(&(arg->den));
761     }
762    
763    
764     //08/07/01: Visual inspection OK.
765     void GMP_RATS_mpq_set_si(GMP_RATS_mpq_struct *arg,
766     int num,
767     int den)
768     {
769     //Eyeball the input parameters.
770     assert(arg != NULL);
771    
772     //Set the numerator and denominator.
773     GMP_INTS_mpz_set_si(&(arg->num), num);
774     GMP_INTS_mpz_set_si(&(arg->den), den);
775     }
776    
777    
778     //08/08/01: Visual inspection OK.
779     void GMP_RATS_mpq_copy( GMP_RATS_mpq_struct *dst,
780     const GMP_RATS_mpq_struct *src)
781     {
782     assert(dst != NULL);
783     assert(src != NULL);
784    
785     GMP_INTS_mpz_copy(&(dst->num), &(src->num));
786     GMP_INTS_mpz_copy(&(dst->den), &(src->den));
787     }
788    
789    
790     //08/13/01: Visual inspection OK.
791     void GMP_RATS_mpq_swap( GMP_RATS_mpq_struct *a,
792     GMP_RATS_mpq_struct *b)
793     {
794     assert(a != NULL);
795     assert(b != NULL);
796    
797     //Handle the swap by swapping integer components.
798     GMP_INTS_mpz_swap(&(a->num), &(b->num));
799     GMP_INTS_mpz_swap(&(a->den), &(b->den));
800     }
801    
802    
803     //08/13/01: Visual inspection OK.
804     void GMP_RATS_mpq_swap_components(GMP_RATS_mpq_struct *arg)
805     {
806     assert(arg != NULL);
807    
808     GMP_INTS_mpz_swap(&(arg->num), &(arg->den));
809     }
810    
811    
812     //08/07/01: Visual inspection OK.
813     void GMP_RATS_mpq_set_complex_slash_sepd_rat_num(const char *s,
814     int *failure,
815     GMP_RATS_mpq_struct *rn)
816     {
817     char *slash_posn, *numerator, *denominator;
818     int s_len, numerator_len, denominator_len;
819     int i;
820    
821     //Eyeball the input parameters.
822     assert(s != NULL);
823     assert(failure != NULL);
824     assert(rn != NULL);
825    
826     //Start off believing there is no failure.
827     *failure = 0;
828    
829     //Figure out if there is one and only one slash in the
830     //string. If this condition isn't met, we cannot
831     //go further.
832     slash_posn = strchr(s, '/');
833     if (!slash_posn)
834     {
835     *failure = 1;
836     return;
837     }
838     if (strchr(slash_posn + 1, '/')) //There is a second occurence.
839     {
840     *failure = 1;
841     return;
842     }
843    
844     //At this point we have one and only one slash.
845     //Crack the string in two. We must do this because the
846     //input is a constant string. We are not allowed to touch it
847     //in the logical domain because of the "const" keyword. We can't
848     //do this in the physical domain because the debugger will nail
849     //us for it.
850     s_len = strlen(s);
851     numerator_len = slash_posn - s;
852     denominator_len = strlen(slash_posn + 1);
853     #if defined(APP_TYPE_SIMPLE_DOS_CONSOLE)
854     numerator = CCMALLOC_malloc(sizeof(char) * (numerator_len + 1));
855     denominator = CCMALLOC_malloc(sizeof(char) * (denominator_len + 1));
856     #elif defined(APP_TYPE_IJUSCRIPTER_IJUCONSOLE)
857     numerator = TclpAlloc(sizeof(char) * (numerator_len + 1));
858     denominator = TclpAlloc(sizeof(char) * (denominator_len + 1));
859     #else
860     numerator = malloc(sizeof(char) * (numerator_len + 1));
861     denominator = malloc(sizeof(char) * (denominator_len + 1));
862     #endif
863    
864     assert(numerator != NULL);
865     assert(denominator != NULL);
866    
867     for (i=0; i<numerator_len; i++)
868     {
869     numerator[i] = s[i];
870     }
871     numerator[numerator_len] = 0;
872    
873     for (i=0; i<denominator_len; i++)
874     {
875     denominator[i] = s[slash_posn - s + 1 + i];
876     }
877     denominator[denominator_len] = 0;
878    
879     //Try to parse out the numerator as an arbitrary integer.
880     //If this can't be done, it is an immediate failure.
881     GMP_INTS_mpz_set_general_int(&(rn->num),
882     failure,
883     numerator);
884     if (*failure)
885     {
886     *failure = 1; //Clamp to 1, don't know what non-zero value
887     //was there.
888     goto ret_pt;
889     }
890    
891     //Try to parse out the denominator.
892     GMP_INTS_mpz_set_general_int(&(rn->den),
893     failure,
894     denominator);
895     if (*failure)
896     {
897     *failure = 1; //Clamp to 1, don't know what non-zero value
898     //was there.
899     goto ret_pt;
900     }
901    
902     //At this point, we have both a numerator and denominator.
903     //Clean up and return.
904     ret_pt:
905     #if defined(APP_TYPE_SIMPLE_DOS_CONSOLE)
906     CCMALLOC_free(numerator);
907     CCMALLOC_free(denominator);
908     #elif defined(APP_TYPE_IJUSCRIPTER_IJUCONSOLE)
909     TclpFree(numerator);
910     TclpFree(denominator);
911     #else
912     free(numerator);
913     free(denominator);
914     #endif
915     }
916    
917    
918     //08/07/01: Visual inspection OK.
919     void GMP_RATS_mpq_set_sci_not_rat_num(const char *s,
920     int *failure,
921     GMP_RATS_mpq_struct *rn)
922     {
923     int parse_failure;
924     //Return code from the floating point parsing
925     //function.
926     char mant_sign;
927     //Sign character, if any, from the mantissa,
928     //or N otherwise.
929     size_t mant_bdp;
930     //The index to the start of the mantissa before
931     //the decimal point.
932     size_t mant_bdp_len;
933     //The length of the mantissa before the decimal
934     //point. Zero means not defined, i.e. that
935     //no characters were parsed and interpreted as
936     //that part of a floating point number.
937     size_t mant_adp;
938     size_t mant_adp_len;
939     //Similar fields for after the decimal point.
940     char exp_sign;
941     //Sign of the exponent, if any, or N otherwise.
942     size_t exp;
943     size_t exp_len;
944     //Similar fields as to the mantissa, but for the
945     //exponent.
946     size_t si;
947     //Iteration variable.
948     int exponent_val;
949     //The value of the exponent. We can't accept
950     //an exponent outside the range of a 24-bit
951     //signed integer. The 24-bit limit is arbitrary.
952     //For one thing, it gives room to detect overflow
953     //as are adding and multiplying by 10.
954    
955     //Eyeball the input parameters.
956     assert(s != NULL);
957     assert(failure != NULL);
958     assert(rn != NULL);
959     //Subcomponents of the rational number will be checked as
960     //we make integer calls, if we're in debug mode.
961    
962     //Start off believing no failure.
963     *failure = 0;
964    
965     //Set the output to 0/1. This is the default case for some
966     //steps below.
967     GMP_RATS_mpq_set_si(rn, 0, 1);
968    
969     //Attempt to parse the number as a general number
970     //in scientific notation.
971     BSTRFUNC_parse_gen_sci_not_num(s,
972     &parse_failure,
973     &mant_sign,
974     &mant_bdp,
975     &mant_bdp_len,
976     &mant_adp,
977     &mant_adp_len,
978     &exp_sign,
979     &exp,
980     &exp_len);
981    
982     //If it wouldn't parse as a general number, can't go further.
983     if (parse_failure)
984     {
985     *failure = 1;
986     return;
987     }
988     else
989     {
990     //The number parsed out. The general strategy is to form a rational number
991     //consisting of the mantissa, with the decimal point shifted fully right, over
992     //a denominator of 1. From there, we process the exponent and combine it with
993     //the number of characters after the decimal point to form a virtual exponent.
994     //If the exponent is positive, we multiply the numerator by the power of 10.
995     //If the exponent is negative, we multiply the denominator by that power of 10.
996    
997     //We want to trim the trailing zeros off of the portion of the mantissa after the
998     //decimal point. We only need to back up indices, no need to make copies, etc.
999     //Note that it is possible that there are only zeros, in which case we'll end
1000     //up with a length of zero.
1001     while ((mant_adp_len > 0) && (s[mant_adp + mant_adp_len - 1]=='0'))
1002     mant_adp_len--;
1003    
1004     //Trim the leading zeros off of the portion of the mantissa before the
1005     //decimal point. Note that it is possible that there is only a zero,
1006     //so we may trim it down to nothing.
1007     while ((mant_bdp_len > 0) && (s[mant_bdp]=='0'))
1008     {
1009     mant_bdp++;
1010     mant_bdp_len--;
1011     }
1012    
1013     //If we have only zeros in the mantissa, both before the
1014     //decimal point and after, then we return 0.
1015     if ((mant_bdp_len + mant_adp_len) == 0)
1016     {
1017     *failure = 0;
1018     return;
1019     }
1020    
1021     //Convert the numerator to an integer which represents the
1022     //part before the mantissa and the part after the mantissa
1023     //concatenated as an integer. We could call a function to do
1024     //this, but the function is not really any better in algorithm.
1025     //We can do it ourselves.
1026     GMP_INTS_mpz_set_ui(&(rn->num), 0);
1027     for (si = 0; si < mant_bdp_len; si++)
1028     {
1029     int val;
1030    
1031     GMP_INTS_mpz_mul_si(&(rn->num), &(rn->num), 10);
1032     val = CHARFUNC_digit_to_val(s[mant_bdp + si]);
1033     if (val >= 0)
1034     GMP_INTS_mpz_add_ui(&(rn->num), &(rn->num), val);
1035     }
1036     for (si = 0; si < mant_adp_len; si++)
1037     {
1038     int val;
1039    
1040     GMP_INTS_mpz_mul_si(&(rn->num), &(rn->num), 10);
1041     val = CHARFUNC_digit_to_val(s[mant_adp + si]);
1042     if (val >= 0)
1043     GMP_INTS_mpz_add_ui(&(rn->num), &(rn->num), val);
1044     }
1045    
1046     //The numerator should now have an integer which is
1047     //The absolute value of the mantissa. Process the possible
1048     //sign.
1049     if (mant_sign == '-')
1050     GMP_INTS_mpz_negate(&(rn->num));
1051    
1052     //We now need to form a value from the exponent, if any.
1053     //First, tackle the exponent. Process the
1054     //exponent into a signed integer. We have to
1055     //balk at anything outside of 24 bits. The
1056     //procedure used automatically handles
1057     //leading zeros correctly.
1058     exponent_val = 0;
1059     for (si=exp; si<(exp+exp_len); si++)
1060     {
1061     int val;
1062    
1063     val = CHARFUNC_digit_to_val(s[si]);
1064    
1065     assert(val >= 0 && val <= 9);
1066    
1067     exponent_val *= 10;
1068     exponent_val += val;
1069    
1070     if (((exp_sign=='-') && (exponent_val>8388608))
1071     ||
1072     ((exp_sign != '-') && (exponent_val>8388607)))
1073     {
1074     *failure = 1;
1075     return;
1076     }
1077     }
1078    
1079     //If we're here, the exponent has been computed and
1080     //is within 24 bits. However, we need to adjust for
1081     //the sign.
1082     if (exp_sign == '-')
1083     exponent_val = -exponent_val;
1084    
1085     //We need to adjust the exponent for the number of digits
1086     //after the decimal point.
1087     exponent_val -= mant_adp_len;
1088    
1089     //Again, clip for size.
1090     if ((exponent_val < -8388608) || (exponent_val > 8388607))
1091     {
1092     *failure = 1;
1093     return;
1094     }
1095    
1096     //There are two cases to consider. If the exponent
1097     //is positive, we need to multiply the numerator
1098     //by 10 exponentiated to the power of the exponent.
1099     //If the exponent is negative, we need to do the
1100     //same thing to the denominator. If the exponent
1101     //is negative, we don't need to do anything.
1102     if (exponent_val > 0)
1103     {
1104     GMP_INTS_mpz_struct k10, k10_exponentiated;
1105    
1106     GMP_INTS_mpz_init(&k10);
1107     GMP_INTS_mpz_init(&k10_exponentiated);
1108    
1109     GMP_INTS_mpz_set_ui(&k10, 10);
1110    
1111     GMP_INTS_mpz_pow_ui(&k10_exponentiated, &k10, exponent_val);
1112    
1113     GMP_INTS_mpz_mul(&(rn->num), &(rn->num), &k10_exponentiated);
1114    
1115     GMP_INTS_mpz_clear(&k10);
1116     GMP_INTS_mpz_clear(&k10_exponentiated);
1117    
1118     *failure = 0;
1119    
1120     if (GMP_INTS_mpz_get_flags(&(rn->num)) || GMP_INTS_mpz_get_flags(&(rn->den)))
1121     *failure = 1;
1122    
1123     return;
1124     }
1125     else if (exponent_val < 0)
1126     {
1127     GMP_INTS_mpz_struct k10, k10_exponentiated;
1128    
1129     GMP_INTS_mpz_init(&k10);
1130     GMP_INTS_mpz_init(&k10_exponentiated);
1131    
1132     GMP_INTS_mpz_set_ui(&k10, 10);
1133    
1134     GMP_INTS_mpz_pow_ui(&k10_exponentiated, &k10, -exponent_val);
1135    
1136     GMP_INTS_mpz_mul(&(rn->den), &(rn->den), &k10_exponentiated);
1137    
1138     GMP_INTS_mpz_clear(&k10);
1139     GMP_INTS_mpz_clear(&k10_exponentiated);
1140    
1141     *failure = 0;
1142    
1143     if (GMP_INTS_mpz_get_flags(&(rn->num)) || GMP_INTS_mpz_get_flags(&(rn->den)))
1144     *failure = 1;
1145    
1146     return;
1147     }
1148     }
1149     }
1150    
1151    
1152     //08/07/01: Visual inspection OK.
1153     void GMP_RATS_mpq_set_all_format_rat_num(const char *s,
1154     int *failure,
1155     GMP_RATS_mpq_struct *rn)
1156     {
1157     //Eyeball the input parameters.
1158     assert(s != NULL);
1159     assert(failure != NULL);
1160     assert(rn != NULL);
1161    
1162     //Assume no failure.
1163     *failure = 0;
1164    
1165     //Try in order to parse as integers with slash then
1166     //as number in scientific notation.
1167     GMP_RATS_mpq_set_complex_slash_sepd_rat_num(s,
1168     failure,
1169     rn);
1170     if (!*failure)
1171     return;
1172    
1173     GMP_RATS_mpq_set_sci_not_rat_num(s,
1174     failure,
1175     rn);
1176    
1177     if (*failure)
1178     *failure = 1; //Clamp output.
1179     }
1180    
1181    
1182     /******************************************************************/
1183     /*** NORMALIZATION FUNCTIONS ************************************/
1184     /******************************************************************/
1185     //08/07/01: Visual inspection OK.
1186     void GMP_RATS_mpq_normalize_sign(GMP_RATS_mpq_struct *rn)
1187     {
1188     //Eyeball the input.
1189     assert(rn != NULL);
1190    
1191     if (GMP_INTS_mpz_is_neg(&rn->num) && GMP_INTS_mpz_is_neg(&rn->den))
1192     {
1193     //Both negative, can negate both, this leaves both positive,
1194     //which is the normalized form for a positive rational
1195     //number.
1196     GMP_INTS_mpz_negate(&rn->num);
1197     GMP_INTS_mpz_negate(&rn->den);
1198     }
1199     else if (!GMP_INTS_mpz_is_neg(&rn->num) && GMP_INTS_mpz_is_neg(&rn->den))
1200     {
1201     //Denominator neg, numerator non-neg, can negate both. This
1202     //will leave numerator neg, denominator pos, which is
1203     //normalized form for negative rational number.
1204     GMP_INTS_mpz_negate(&rn->num);
1205     GMP_INTS_mpz_negate(&rn->den);
1206     }
1207     }
1208    
1209    
1210     //08/07/01: Visual inspection OK.
1211     void GMP_RATS_mpq_normalize(GMP_RATS_mpq_struct *rn)
1212     {
1213     //Eyeball the input.
1214     assert(rn != NULL);
1215    
1216     //Cover some special cases. If either component has flags
1217     //set, don't even touch it.
1218     if (GMP_INTS_mpz_get_flags(&(rn->num)) || GMP_INTS_mpz_get_flags(&(rn->den)))
1219     {
1220     return;
1221     }
1222     //If the denominator is zero, normalize it to 1/0, the canonical
1223     //for for an illegal rational number.
1224     else if (GMP_INTS_mpz_is_zero(&(rn->den)))
1225     {
1226     GMP_RATS_mpq_set_si(rn, 1, 0);
1227     return;
1228     }
1229     //If the numerator is zero, convert the number to the canonical
1230     //form for zero of 0/1.
1231     else if (GMP_INTS_mpz_is_zero(&(rn->num)))
1232     {
1233     GMP_RATS_mpq_set_si(rn, 0, 1);
1234     return;
1235     }
1236     else
1237     {
1238     int num_is_neg;
1239     int den_is_neg;
1240     GMP_INTS_mpz_struct gcd, quotient, remainder;
1241    
1242     //Allocate space for the integers used.
1243     GMP_INTS_mpz_init(&gcd);
1244     GMP_INTS_mpz_init(&quotient);
1245     GMP_INTS_mpz_init(&remainder);
1246    
1247     //This is the most normal case, where we need to
1248     //look at reducing the numerator and denominator.
1249     //One way to do it would be to obtain the g.c.d.
1250     //and divide this out, and this is the route
1251     //we'll take. However, must grab out the sign.
1252     if (GMP_INTS_mpz_is_neg(&(rn->num)))
1253     {
1254     num_is_neg = 1;
1255     GMP_INTS_mpz_negate(&(rn->num));
1256     }
1257     else
1258     {
1259     num_is_neg = 0;
1260     }
1261    
1262     if (GMP_INTS_mpz_is_neg(&(rn->den)))
1263     {
1264     den_is_neg = 1;
1265     GMP_INTS_mpz_negate(&(rn->den));
1266     }
1267     else
1268     {
1269     den_is_neg = 0;
1270     }
1271    
1272     //Calculate the GCD.
1273     GMP_INTS_mpz_gcd(&gcd, &(rn->num), &(rn->den));
1274    
1275     //Divide the numerator by the GCD and store it
1276     //back.
1277     GMP_INTS_mpz_tdiv_qr(&quotient, &remainder,
1278     &(rn->num), &gcd);
1279     GMP_INTS_mpz_copy(&(rn->num), &quotient);
1280    
1281     //Divide the denominator by the GCD and store it
1282     //back.
1283     GMP_INTS_mpz_tdiv_qr(&quotient, &remainder,
1284     &(rn->den), &gcd);
1285     GMP_INTS_mpz_copy(&(rn->den), &quotient);
1286    
1287     //We now need to adjust the sign. Both the
1288     //numerator and denominator are definitely
1289     //positive. Need to make the numerator
1290     //negative if either but not both of the
1291     //original signs were negative.
1292     if ((num_is_neg && !den_is_neg) || (!num_is_neg && den_is_neg))
1293     {
1294     GMP_INTS_mpz_negate(&(rn->num));
1295     }
1296    
1297     //Deallocate space for the integers used.
1298     GMP_INTS_mpz_clear(&gcd);
1299     GMP_INTS_mpz_clear(&quotient);
1300     GMP_INTS_mpz_clear(&remainder);
1301    
1302     return;
1303     }
1304     }
1305    
1306    
1307     /******************************************************************/
1308     /*** ARITHMETIC FUNCTIONS ***************************************/
1309     /******************************************************************/
1310     //08/08/01: Visual inspection OK.
1311     void GMP_RATS_mpq_add( GMP_RATS_mpq_struct *result,
1312     const GMP_RATS_mpq_struct *arg1,
1313     const GMP_RATS_mpq_struct *arg2)
1314     {
1315     GMP_RATS_mpq_struct rv;
1316     GMP_INTS_mpz_struct temp;
1317    
1318     //Eyeball the input parameters.
1319     assert(result != NULL);
1320     assert(arg1 != NULL);
1321     assert(arg2 != NULL);
1322    
1323     //Generally speaking, we do not want to require that
1324     //the arguments and the result be distinct, as this is
1325     //too much of a restriction on the caller. The approach
1326     //taken, somewhat wasteful, is to allocate a place for
1327     //the return value.
1328     //
1329     //For addition, if we are adding a/b and c/d, the
1330     //result is necessarily algebraically
1331     //(ad + cb)/bd.
1332     //
1333     //If either rational number in the input is invalid,
1334     //flag the result as invalid.
1335     if (GMP_RATS_mpq_is_nan(arg1) || GMP_RATS_mpq_is_nan(arg2))
1336     {
1337     GMP_RATS_mpq_set_si(result, 1, 0);
1338     }
1339     else
1340     {
1341     //Both rational numbers are OK. Can simply stage the
1342     //result by the algebraic identity and then
1343     //normalize it. Only need one temporary variable.
1344     //
1345     //Initialize the rational number that we will use to
1346     //hold return value in case it is the same as one
1347     //or both of the arguments.
1348     GMP_RATS_mpq_init(&rv);
1349    
1350     //Initialize the temporary integer.
1351     GMP_INTS_mpz_init(&temp);
1352    
1353     //numerator = a * d
1354     GMP_INTS_mpz_mul(&(rv.num), &(arg1->num), &(arg2->den));
1355    
1356     //temp = c * b
1357     GMP_INTS_mpz_mul(&temp, &(arg2->num), &(arg1->den));
1358    
1359     //numerator = a * d + c * b
1360     GMP_INTS_mpz_add(&(rv.num), &(rv.num), &temp);
1361    
1362     //denominator = b * d
1363     GMP_INTS_mpz_mul(&(rv.den), &(arg1->den), &(arg2->den));
1364    
1365     //Copy the temporary result to the actual return value.
1366     //Had to wait until now in case result was the same
1367     //as either or both args.
1368     GMP_RATS_mpq_copy(result, &rv);
1369    
1370     //Normalize the result.
1371     GMP_RATS_mpq_normalize(result);
1372    
1373     //Free dynamic memory.
1374     GMP_RATS_mpq_clear(&rv);
1375     GMP_INTS_mpz_clear(&temp);
1376     }
1377     }
1378    
1379    
1380     //08/08/01: Visual inspection OK.
1381     void GMP_RATS_mpq_sub( GMP_RATS_mpq_struct *result,
1382     const GMP_RATS_mpq_struct *arg1,
1383     const GMP_RATS_mpq_struct *arg2)
1384     {
1385     GMP_RATS_mpq_struct negated_arg_2;
1386    
1387     //Eyeball the input parameters.
1388     assert(result != NULL);
1389     assert(arg1 != NULL);
1390     assert(arg2 != NULL);
1391    
1392     //For the subtract function, we could do it directly,
1393     //but might as well just define it recursively
1394     //in terms of add. We can't modify the inputs,
1395     //so copy the second off and negate it. All error
1396     //flags and so forth will propagate automatically.
1397     //
1398     //Allocate space for the negated arg 2.
1399     GMP_RATS_mpq_init(&negated_arg_2);
1400    
1401     //Copy from the original.
1402     GMP_RATS_mpq_copy(&negated_arg_2, arg2);
1403    
1404     //Negate the copy. Negating the numerator will
1405     //do it.
1406     GMP_INTS_mpz_negate(&(negated_arg_2.num));
1407    
1408     //Make the add, which now is really a subtract.
1409     GMP_RATS_mpq_add(result, arg1, &negated_arg_2);
1410    
1411     //Destroy the temporary variable.
1412     GMP_RATS_mpq_clear(&negated_arg_2);
1413     }
1414    
1415    
1416     //08/16/01: Visual inspection OK.
1417     void GMP_RATS_mpq_mul( GMP_RATS_mpq_struct *result,
1418     const GMP_RATS_mpq_struct *arg1,
1419     const GMP_RATS_mpq_struct *arg2)
1420     {
1421     //Eyeball the input parameters.
1422     assert(result != NULL);
1423     assert(arg1 != NULL);
1424     assert(arg2 != NULL);
1425    
1426     //If either rational number in the input is invalid,
1427     //flag the result as invalid.
1428     if (GMP_RATS_mpq_is_nan(arg1) || GMP_RATS_mpq_is_nan(arg2))
1429     {
1430     GMP_RATS_mpq_set_si(result, 1, 0);
1431     }
1432     else
1433     {
1434     //Rational number multiplication is a simple matter.
1435     //Just multiply components. Don't need to worry
1436     //about rational numbers overlapping, as numerator
1437     //operations and denominator operations are separate.
1438     GMP_INTS_mpz_mul(&(result->num),
1439     &(arg1->num),
1440     &(arg2->num));
1441     GMP_INTS_mpz_mul(&(result->den),
1442     &(arg1->den),
1443     &(arg2->den));
1444    
1445     //Normalize it.
1446     GMP_RATS_mpq_normalize(result);
1447     }
1448     }
1449    
1450    
1451     //08/16/01: Visual inspection OK.
1452     void GMP_RATS_mpq_div( GMP_RATS_mpq_struct *result,
1453     const GMP_RATS_mpq_struct *arg1,
1454     const GMP_RATS_mpq_struct *arg2)
1455     {
1456     GMP_RATS_mpq_struct rv;
1457    
1458     //Eyeball the input parameters.
1459     assert(result != NULL);
1460     assert(arg1 != NULL);
1461     assert(arg2 != NULL);
1462    
1463     //If either rational number in the input is invalid,
1464     //flag the result as invalid.
1465     if (GMP_RATS_mpq_is_nan(arg1) || GMP_RATS_mpq_is_nan(arg2))
1466     {
1467     GMP_RATS_mpq_set_si(result, 1, 0);
1468     }
1469     else
1470     {
1471     //Rational number division is a simple matter.
1472     //Just multiply components. We do need to worry
1473     //about rational numbers overlapping, so must
1474     //make a copy of the return value. If denominator
1475     //of return value is zero, it is NAN, but caller
1476     //should detect this.
1477     //
1478     //Allocate return value.
1479     GMP_RATS_mpq_init(&rv);
1480    
1481     //Calculate quotient.
1482     GMP_INTS_mpz_mul(&(rv.num),
1483     &(arg1->num),
1484     &(arg2->den));
1485     GMP_INTS_mpz_mul(&(rv.den),
1486     &(arg1->den),
1487     &(arg2->num));
1488    
1489     //Normalize quotient.
1490     GMP_RATS_mpq_normalize(&rv);
1491    
1492     //Copy to its destination.
1493     GMP_RATS_mpq_copy(result, &rv);
1494    
1495     //Deallocate temporary return value.
1496     GMP_RATS_mpq_clear(&rv);
1497     }
1498     }
1499    
1500    
1501     /******************************************************************/
1502     /*** COMPARISON FUNCTIONS ***************************************/
1503     /******************************************************************/
1504     //08/16/01: Visual inspection OK.
1505     int GMP_RATS_mpq_cmp(const GMP_RATS_mpq_struct *arg1,
1506     const GMP_RATS_mpq_struct *arg2,
1507     int *failure)
1508     {
1509     int arg1_sgn;
1510     int arg2_sgn;
1511     int rv, failure_rv;
1512     GMP_INTS_mpz_struct prod1, prod2;
1513    
1514     //Eyeball the input parameters. Note that the third
1515     //parameter may be NULL.
1516     assert(arg1 != NULL);
1517     assert(arg2 != NULL);
1518    
1519     //If either of the input arguments are NAN, we
1520     //cannot compare arguments. We return 0, and it
1521     //depends on the caller whether it is important
1522     //that the comparison is bogus.
1523     if (GMP_RATS_mpq_is_nan(arg1) || GMP_RATS_mpq_is_nan(arg2))
1524     {
1525     if (failure != NULL)
1526     *failure = 1;
1527     return(0);
1528     }
1529    
1530     //Calculate the sign of the left argument. The encoding
1531     //we'll use is -1 means negative, 0 means zero, and
1532     //1 means positive.
1533     if (GMP_INTS_mpz_is_zero(&(arg1->num)))
1534     {
1535     arg1_sgn = 0;
1536     }
1537     else if (GMP_INTS_mpz_is_neg(&(arg1->num)) && GMP_INTS_mpz_is_neg(&(arg1->den)))
1538     {
1539     arg1_sgn = 1;
1540     }
1541     else if (GMP_INTS_mpz_is_neg(&(arg1->num)) && GMP_INTS_mpz_is_pos(&(arg1->den)))
1542     {
1543     arg1_sgn = -1;
1544     }
1545     else if (GMP_INTS_mpz_is_pos(&(arg1->num)) && GMP_INTS_mpz_is_neg(&(arg1->den)))
1546     {
1547     arg1_sgn = -1;
1548     }
1549     else if (GMP_INTS_mpz_is_pos(&(arg1->num)) && GMP_INTS_mpz_is_pos(&(arg1->den)))
1550     {
1551     arg1_sgn = 1;
1552     }
1553    
1554     //Calculate the sign of the right argument. The encoding
1555     //we'll use is -1 means negative, 0 means zero, and
1556     //1 means positive.
1557     if (GMP_INTS_mpz_is_zero(&(arg2->num)))
1558     {
1559     arg2_sgn = 0;
1560     }
1561     else if (GMP_INTS_mpz_is_neg(&(arg2->num)) && GMP_INTS_mpz_is_neg(&(arg2->den)))
1562     {
1563     arg2_sgn = 1;
1564     }
1565     else if (GMP_INTS_mpz_is_neg(&(arg2->num)) && GMP_INTS_mpz_is_pos(&(arg2->den)))
1566     {
1567     arg2_sgn = -1;
1568     }
1569     else if (GMP_INTS_mpz_is_pos(&(arg2->num)) && GMP_INTS_mpz_is_neg(&(arg2->den)))
1570     {
1571     arg2_sgn = -1;
1572     }
1573     else if (GMP_INTS_mpz_is_pos(&(arg2->num)) && GMP_INTS_mpz_is_pos(&(arg2->den)))
1574     {
1575     arg2_sgn = 1;
1576     }
1577    
1578     //OK, can handle some simple cases where the signs of the
1579     //operands are different or both are zero.
1580     if ((arg1_sgn == 0) && (arg2_sgn == 0))
1581     {
1582     if (failure != NULL)
1583     *failure = 0;
1584     return(0);
1585     }
1586     else if ((arg1_sgn == -1) && (arg2_sgn > -1))
1587     {
1588     if (failure != NULL)
1589     *failure = 0;
1590     return(-1);
1591     }
1592     else if ((arg1_sgn == 0) && (arg2_sgn < 0))
1593     {
1594     if (failure != NULL)
1595     *failure = 0;
1596     return(1);
1597     }
1598     else if ((arg1_sgn == 0) && (arg2_sgn > 0))
1599     {
1600     if (failure != NULL)
1601     *failure = 0;
1602     return(-1);
1603     }
1604     else if ((arg1_sgn == 1) && (arg2_sgn < 1))
1605     {
1606     if (failure != NULL)
1607     *failure = 0;
1608     return(1);
1609     }
1610    
1611     //OK at this point, we cannot make a simple determination
1612     //as to the relative ordering. The signs of arg1 and
1613     //arg2 are both the same, either both positive or both
1614     //negative. We have to do a multiplication to sort
1615     //it out.
1616     //
1617     //Allocate the two integers to hold multiplication
1618     //results.
1619     GMP_INTS_mpz_init(&prod1);
1620     GMP_INTS_mpz_init(&prod2);
1621    
1622     //Cross-multiply to get relative magnitudes.
1623     GMP_INTS_mpz_mul(&prod1, &(arg1->num), &(arg2->den));
1624     GMP_INTS_mpz_mul(&prod2, &(arg1->den), &(arg2->num));
1625    
1626     //Take absolute values.
1627     GMP_INTS_mpz_abs(&prod1);
1628     GMP_INTS_mpz_abs(&prod2);
1629    
1630     //If we overflowed either multiplication and generated
1631     //a NAN, we cannot complete the compare.
1632     if (GMP_INTS_mpz_get_flags(&prod1) || GMP_INTS_mpz_get_flags(&prod2))
1633     {
1634     failure_rv = 1;
1635     rv = 0;
1636     }
1637     //If both rational numbers were effectively positive, we can
1638     //use the relative ordering of the products as the relative
1639     //ordering of the rational numbers.
1640     else if (arg1_sgn == 1)
1641     {
1642     //Compare the integers.
1643     rv = GMP_INTS_mpz_cmp(&prod1, &prod2);
1644    
1645     //Clamp the return value.
1646     if (rv < 0)
1647     rv = -1;
1648     else if (rv == 0)
1649     rv = 0;
1650     else if (rv > 0)
1651     rv = 1;
1652    
1653     //There was no error.
1654     failure_rv = 0;
1655     }
1656     else
1657     {
1658     //The only case that *should* allow us to be here is
1659     //if the sign of both numbers is neg.
1660     assert(arg1_sgn == -1);
1661    
1662     //Compare the integers.
1663     rv = GMP_INTS_mpz_cmp(&prod1, &prod2);
1664    
1665     //Invert and clamp the return value.
1666     if (rv < 0)
1667     rv = 1;
1668     else if (rv == 0)
1669     rv = 0;
1670     else if (rv > 0)
1671     rv = -1;
1672    
1673     //There was no error.
1674     failure_rv = 0;
1675     }
1676    
1677     //Deallocate the two integers.
1678     GMP_INTS_mpz_clear(&prod1);
1679     GMP_INTS_mpz_clear(&prod2);
1680    
1681     //Return the return values.
1682     if (failure != NULL)
1683     *failure = failure_rv;
1684     return(rv);
1685     }
1686    
1687    
1688     /******************************************************************/
1689     /*** VERSION CONTROL REPORTING FUNCTIONS ************************/
1690     /******************************************************************/
1691     //08/07/01: Visual inspection OK.
1692     const char *GMP_RATS_cvcinfo(void)
1693     {
1694     return("$Header: /cvsroot/esrg/sfesrg/esrgpcpj/shared/c_datd/gmp_rats.c,v 1.10 2001/08/16 19:49:40 dtashley Exp $");
1695     }
1696    
1697    
1698     //08/07/01: Visual inspection OK.
1699     const char *GMP_RATS_hvcinfo(void)
1700     {
1701     return(GMP_RATS_H_VERSION);
1702     }
1703    
1704    
1705     //**************************************************************************
1706     // $Log: gmp_rats.c,v $
1707     // Revision 1.10 2001/08/16 19:49:40 dtashley
1708     // Beginning to prepare for v1.05 release.
1709     //
1710     // Revision 1.9 2001/08/15 06:56:05 dtashley
1711     // Substantial progress. Safety check-in.
1712     //
1713     // Revision 1.8 2001/08/12 10:20:58 dtashley
1714     // Safety check-in. Substantial progress.
1715     //
1716     // Revision 1.7 2001/08/10 00:53:59 dtashley
1717     // Completion of basic rational number arithmetic utilities and extensions.
1718     //
1719     // Revision 1.6 2001/08/08 02:16:51 dtashley
1720     // Completion of RNRED utility and ARBINT RNRED Tcl extension.
1721     //
1722     // Revision 1.5 2001/08/07 10:42:48 dtashley
1723     // Completion of CFRATNUM extensions and DOS command-line utility.
1724     //
1725     // Revision 1.4 2001/07/13 21:02:20 dtashley
1726     // Version control reporting changes.
1727     //
1728     // Revision 1.3 2001/07/13 20:44:42 dtashley
1729     // Changes, CVS keyword expansion test.
1730     //
1731     // Revision 1.2 2001/07/13 00:57:08 dtashley
1732     // Safety check-in. Substantial progress on port.
1733     //
1734     // Revision 1.1 2001/07/12 05:42:06 dtashley
1735     // Initial checkin.
1736     //
1737     //**************************************************************************
1738     // End of GMP_RATS.C.

dashley@gmail.com
ViewVC Help
Powered by ViewVC 1.1.25