gpl.txt 0000664 0000764 0000764 00000104513 11340650544 012321 0 ustar quinlan quinlan GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
Makefile 0000644 0000764 0000764 00000003223 11345300212 012415 0 ustar quinlan quinlan #*************************************************************************#
#* *#
#* Makefile for GritBot *#
#* -------------------- *#
#* *#
#*************************************************************************#
CC = gcc -ffloat-store
CFLAGS = -DVerbOpt -g -Wall -O0
LFLAGS = $(S)
SHELL = /bin/csh
# Definitions of file sets
src =\
global.c\
cluster.c\
continatt.c\
outlier.c\
getdata.c\
gritbot.c\
sort.c\
discratt.c\
check.c\
common.c\
getnames.c\
implicitatt.c\
modelfiles.c\
update.c\
utility.c
isrc =\
inspect.c\
cluster.c\
outlier.c\
getdata.c\
getnames.c\
implicitatt.c\
modelfiles.c\
update.c\
common.c\
utility.c
obj =\
global.o\
gritbot.o\
getdata.o getnames.o implicitatt.o\
check.o cluster.o outlier.o\
common.o continatt.o discratt.o\
modelfiles.o\
sort.o utility.o update.o
all:
make gritbot
make inspect
# debug version (including verbosity option)
gritbotdbg:\
$(obj) defns.i text.i extern.i Makefile
$(CC) -DVerbOpt -g -o gritbotdbg $(obj) -lm
inspectdbg:\
$(isrc) defns.i text.i Makefile
cat defns.i $(isrc)\
| egrep -v 'defns.i|extern.i' >insgt.c
$(CC) $(CFLAGS) -DVerbOpt -DINSPECT -o inspectdbg insgt.c -lm
# production versions
gritbot:\
$(src) defns.i text.i Makefile
cat defns.i $(src)\
| egrep -v 'defns.i|extern.i' >gbotgt.c
$(CC) $(LFLAGS) -O3 -o gritbot gbotgt.c -lm
strip gritbot
rm gbotgt.c
inspect:\
$(isrc) defns.i text.i Makefile
cat defns.i $(isrc)\
| egrep -v 'defns.i|extern.i' >insgt.c
$(CC) $(LFLAGS) -DINSPECT -O3 -o inspect insgt.c -lm
strip inspect
rm insgt.c
$(obj): Makefile defns.i extern.i
.c.o:
$(CC) $(CFLAGS) -c $<
check.c 0000664 0000764 0000764 00000057470 11501534524 012226 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Principal routines to check data */
/* -------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
Boolean CheckMsg; /* message printed for current attribute */
CaseNo LowFp, LowLp, HighFp; /* pointers to omitted low/high tails */
/*************************************************************************/
/* */
/* Check each attribute in turn */
/* */
/*************************************************************************/
void CheckData()
/* --------- */
{
CaseNo i, Fp, Lp;
NotifyStage(PRELIM);
/* Set up tables, determine discrete value priors, etc. */
InitialiseDAC();
/* Initialise random numbers for sampling */
ResetKR(0);
DMINITEMS = CMINITEMS = Max(35, 0.005 * (MaxCase+1));
LowFp = 0;
LowLp = -1;
HighFp = MaxCase+1;
if ( SIFT )
{
CheckFile(".sift", true);
}
/* Set ClassAtt to each attribute in turn.
Check distribution type, remove tails, and perform global check */
ForEach(ClassAtt, 1, MaxAtt)
{
if ( Exclude(ClassAtt) )
{
continue;
}
Verbosity(1, fprintf(Of, "\n==========\n%s\n", AttName[ClassAtt]))
Progress(-ClassAtt);
CheckMsg = false;
/* Delete missing values and set SomeMiss[].
SomeNA[] is set in CheckContin (for continuous atts)
and in InitialiseDAC (for discrete atts) */
Fp = SkipMissing(ClassAtt, 0, MaxCase);
if ( (SomeMiss[ClassAtt] = ( Fp > 0 )) && ! Skip(ClassAtt) )
{
fprintf(Of, F_WhileCheck, AttName[ClassAtt]);
fprintf(Of, F_ExcludeMissing(Fp));
CheckMsg = true;
}
if ( Fp < MaxCase )
{
TargetSaved = false;
GEnv.Level = -1;
if ( Continuous(ClassAtt) )
{
CheckContin(Fp);
}
else
if ( SIFT )
{
/* Check for possible entries for sift file */
ForEach(i, Fp, MaxCase)
{
Case[i][0] = Case[i][ClassAtt];
}
FindDiscrOutliers(Fp, MaxCase, Nil);
}
/* Dump any sift entries */
if ( SIFT && GEnv.SiftSize )
{
fprintf(Sf, "1 %d\n%s", ClassAtt, GEnv.SiftEntry);
GEnv.SiftSize = 0;
}
}
}
/* Search for subsets and test */
NotifyStage(CHECKING);
ForEach(ClassAtt, 1, MaxAtt)
{
if ( Skip(ClassAtt) ) continue;
Verbosity(1, fprintf(Of, "\n==========\n%s\n", AttName[ClassAtt]))
Progress(-ClassAtt);
/* Restore original order */
memcpy(Case, SaveCase, (MaxCase+1) * sizeof(Description));
/* Remove missing values and tails of continuous attributes */
Fp = ( SomeMiss[ClassAtt] ? SkipMissing(ClassAtt, 0, MaxCase) : 0 );
Lp = MaxCase;
if ( Continuous(ClassAtt) )
{
/* Remove N/A values */
if ( SomeNA[ClassAtt] ) Fp = Group(ClassAtt, 1, Fp, Lp, 0, Nil);
/* Put low tails low and high tails high */
LowFp = Fp;
ForEach(i, Fp, Lp)
{
if ( CVal(Case[i], ClassAtt) < LowTail[ClassAtt] )
{
Swap(i, Fp);
Fp++;
}
else
if ( CVal(Case[i], ClassAtt) > HighTail[ClassAtt] )
{
Swap(i, Lp);
Lp--;
i--;
}
}
LowLp = Fp-1;
HighFp = Lp+1;
}
if ( Fp > 0 ) Progress(Fp);
/* Copy class values */
if ( Continuous(ClassAtt) && UseLogs[ClassAtt] )
{
ForEach(i, Fp, Lp)
{
CClass(Case[i]) = log(CVal(Case[i], ClassAtt));
}
}
else
{
ForEach(i, Fp, Lp)
{
Case[i][0] = Case[i][ClassAtt];
}
}
SampleSize = SAMPLEUNIT *
( Continuous(ClassAtt) ? 5 :
SomeNA[ClassAtt] ? MaxAttVal[ClassAtt] :
MaxAttVal[ClassAtt] - 1 );
Split(Fp, Lp, 0, Nil, 0, &T);
TargetSaved = false;
LastLevel = -1;
ReleaseTree(T, 0);
T = Nil;
}
if ( SIFT )
{
fprintf(Sf, "0\n");
fclose(Sf);
Sf = 0;
}
}
/*************************************************************************/
/* */
/* Check a continuous attribute */
/* - decide whether to apply the log transformation */
/* - exclude possibly multimodal tails */
/* - check for global outliers */
/* */
/*************************************************************************/
void CheckContin(CaseNo Fp)
/* ----------- */
{
CaseNo i, Mid, Quart, Tail, Tp, Lp;
CaseCount Cases, Middle;
double R1, R2, Mean, SD, Sum=0, SumSq=0, Cv;
char CVS[20];
Boolean LowT=false, HighT=false;
/* First discard any non-applicable values */
Tp = Fp;
ForEach(i, Fp, MaxCase)
{
if ( NotApplic(Case[i], ClassAtt) )
{
Swap(Fp, i);
Fp++;
}
}
/* Remember whether there were any */
if ( (SomeNA[ClassAtt] = ( Fp > Tp )) && ! Skip(ClassAtt) )
{
if ( ! CheckMsg )
{
fprintf(Of, F_WhileCheck, AttName[ClassAtt]);
CheckMsg = true;
}
fprintf(Of, F_ExcludeNA(Fp - Tp));
}
if ( Fp > MaxCase - CMINITEMS ) return;
Quicksort(Fp, MaxCase, ClassAtt);
Mid = (MaxCase + Fp) / 2;
/* Check for asymmetry and potential log distribution */
Quart = No(Fp, MaxCase) / 4;
if ( CVal(Case[Fp], ClassAtt) > Epsilon &&
CVal(Case[MaxCase-Quart], ClassAtt) > CVal(Case[Mid], ClassAtt) )
{
/* R1 is (log(q2)-log(q1)) / (log(q3)-log(q2))
R2 is (q2-q1) / (q3-q2)
Choose the log distribution if R2 < 1 and R1 is closer
to 1 than R2 */
R1 = ( log(CVal(Case[Mid], ClassAtt)) -
log(CVal(Case[Fp+Quart], ClassAtt)) ) /
( log(CVal(Case[MaxCase-Quart], ClassAtt)) -
log(CVal(Case[Mid], ClassAtt)) );
R2 = (CVal(Case[Mid], ClassAtt) - CVal(Case[Fp+Quart], ClassAtt)) /
(CVal(Case[MaxCase-Quart], ClassAtt) - CVal(Case[Mid], ClassAtt));
UseLogs[ClassAtt] = R2 < 1 && fabs(R1-1) < fabs(R2-1);
if ( UseLogs[ClassAtt] )
{
Verbosity(1, fprintf(Of, " Using log distribution\n"))
if ( SIFT )
{
fprintf(Sf, "2 %d\n", ClassAtt);
}
}
}
else
{
UseLogs[ClassAtt] = false;
}
/* That's all that needs to be done for non-included attributes */
if ( Skip(ClassAtt) ) return;
/* Load the appropriate values into the class */
if ( UseLogs[ClassAtt] )
{
ForEach(i, Fp, MaxCase)
{
CClass(Case[i]) = log(CVal(Case[i], ClassAtt));
}
}
else
{
ForEach(i, Fp, MaxCase)
{
CClass(Case[i]) = CVal(Case[i], ClassAtt);
}
}
/* Check for multimodal tails and exclude */
Lp = MaxCase;
Cases = No(Fp, Lp);
Tail = MaxAnoms(Cases);
/* Estimate SD from the central half of the data and adjust; if
this is impossible (too many repeated values), mark the
attribute as skipped */
if ( CClass(Case[Fp + Quart + Tail]) < CClass(Case[Lp - Quart - Tail]) )
{
ForEach(i, Fp + Quart, Lp - Quart)
{
Sum += (Cv = CClass(Case[i]));
SumSq += Cv * Cv;
}
Mean = Sum / (Middle = No(Fp, Lp) - 2 * Quart);
SD = 2.5 * SDEstimate(Middle, Sum, SumSq);
}
else
{
/* This is not really a continuous distribution -- at least
half of the cases have identical values. Skip it */
if ( ! CheckMsg )
{
fprintf(Of, F_WhileCheck, AttName[ClassAtt]);
CheckMsg = true;
}
fprintf(Of, F_TooManyIdentical);
SpecialStatus[ClassAtt] |= SKIP;
return;
}
/* Look for multimodal low tail */
for ( Tp = Fp ; Tp < Mid && ZScore(Tp) >= MAXTAIL ; Tp++ )
;
if ( Tp - Fp > Tail )
{
if ( ! CheckMsg )
{
fprintf(Of, F_WhileCheck, AttName[ClassAtt]);
CheckMsg = true;
}
CValToStr(CVal(Case[Tp], ClassAtt), ClassAtt, CVS);
fprintf(Of, F_LowTail(Tp - Fp, CVS));
Fp = Tp;
LowT = true;
}
/* Ditto multimodal high tail */
for ( Tp = Lp ; Tp > Mid && ZScore(Tp) >= MAXTAIL ; Tp-- )
;
if ( Lp - Tp > Tail )
{
if ( ! CheckMsg )
{
fprintf(Of, F_WhileCheck, AttName[ClassAtt]);
CheckMsg = true;
}
CValToStr(CVal(Case[Tp], ClassAtt), ClassAtt, CVS);
fprintf(Of, F_HighTail(Lp - Tp, CVS));
Lp = Tp;
HighT = true;
}
/* Record tail information */
LowTail[ClassAtt] = CVal(Case[Fp], ClassAtt);
HighTail[ClassAtt] = CVal(Case[Lp], ClassAtt);
if ( SIFT && ( LowT || HighT ) )
{
fprintf(Sf, "3 %d %.8g %.8g\n", ClassAtt,
( LowT ? CVal(Case[Fp], ClassAtt) : -MAXFLOAT ),
( HighT ? CVal(Case[Lp], ClassAtt) : MAXFLOAT ) );
}
/* Carry out global check on remaining cases */
FindContinOutliers(Fp, Lp, true);
}
/*************************************************************************/
/* */
/* Check continuous values of ClassAtt for cases Fp to Lp */
/* */
/*************************************************************************/
void FindContinOutliers(CaseNo Fp, CaseNo Lp, Boolean Sorted)
/* ------------------ */
{
CaseNo Tail, Cases, LowTp=-1, HighTp=-1, GFp, i;
double Mean, SD, LowFrac, HighFrac, LowLim, HighLim;
Clust CLow=Nil, CHigh=Nil;
Boolean SavedCluster=false;
Cases = No(Fp, Lp);
if ( Cases < CMINITEMS ) return;
if ( ! Sorted )
{
Quicksort(Fp, Lp, ClassAtt);
}
TrimmedSDEstimate(Fp, Lp, &Mean, &SD);
/* Check low and high tails. A tail is anomalous if
* it does not contain too many cases
* the case before the tail has a Z-score <= MAXNORM
* there is a gap of at least MINABNORM - MAXNORM */
Tail = MaxAnoms(Cases);
LowTp = FindTail(Fp, Fp + Tail, 1, Mean, SD);
HighTp = FindTail(Lp, Lp - Tail, -1, Mean, SD);
if ( SIFT )
{
/* See whether we need to save this cluster for low or high test */
if ( LowTp >= 0 )
{
LowFrac = No(LowTp+1, Lp) / (double) Cases;
LowLim = CVal(Case[LowTp+1], ClassAtt);
}
else
{
LowFrac = LowLim = 0;
}
if ( HighTp > 0 )
{
HighFrac = No(Fp, HighTp-1) / (double) Cases;
HighLim = CVal(Case[HighTp-1], ClassAtt);
}
else
{
HighFrac = HighLim = 0;
}
if ( LowFrac > 0 || HighFrac > 0 )
{
SaveContinCluster(Mean, SD, Cases,
LowFrac, LowLim, HighFrac, HighLim);
SavedCluster = true;
}
}
if ( LowTp >= 0 || HighTp > 0 )
{
GFp = ( LowTp >= 0 ? LowTp+1 : Fp );
if ( LowTp >= 0 )
{
CLow = NewClust(Mean, SD,
CVal(Case[LowTp+1], ClassAtt),
No(Fp, LowTp), Cases);
}
if ( HighTp > 0 )
{
CHigh = NewClust(Mean, SD,
CVal(Case[HighTp-1], ClassAtt),
No(HighTp, Lp), Cases);
/* Move all anomalies to the front */
ForEach(i, HighTp, Lp)
{
Swap(i, GFp);
GFp++;
}
}
LabelContinOutliers(CLow, CHigh, Fp, GFp, Lp);
}
/* Clusters may have caveats discovered during LabelContinOutliers */
if ( SavedCluster )
{
ExtendSiftEntry("\n");
}
}
/*************************************************************************/
/* */
/* Note cases Fp to Lp as outliers wrt values GFp to GLp of */
/* ClassAtt whose mean and SD are given */
/* */
/*************************************************************************/
void LabelContinOutliers(Clust CL, Clust CH, CaseNo Fp, CaseNo GFp, CaseNo GLp)
/* ------------------- */
{
CaseNo i;
double Z, Mean, SD, X;
Clust C, OldC;
C = ( CL ? CL : CH ); /* either will do since mean is the same */
Mean = C->Expect;
SD = C->SD;
/* Remove cases that already have a more interesting recorded
anomalous value */
ForEach(i, Fp, GFp-1)
{
/* Use Chebychev bounds to approximate certainty that this
case is an outlier */
Z = ZScore(i);
X = 1 / (Z * Z);
if ( (OldC = OutClust(Case[i])) &&
( C->NCond > OldC->NCond ||
C->NCond == OldC->NCond && X >= OutXVal(Case[i]) ) )
{
Swap(i, Fp);
Fp++;
}
}
/* Remove possible anomalies that are non consistent with the
ordinary cases */
Fp = NoOtherDifference(Fp, GFp-1, GFp, GLp);
/* Finally, record remaining cases */
ForEach(i, Fp, GFp-1)
{
Z = ZScore(i);
Verbosity(1,
fprintf(Of, "****\tpotential outlier %g (%.1f sd) %s\n",
CVal(Case[i], ClassAtt), Z,
( LabelAtt ? SVal(Case[i], LabelAtt) : "" )))
RecordOutlier(i, ( CClass(Case[i]) < Mean ? CL : CH ), 1 / (Z * Z));
}
}
/*************************************************************************/
/* */
/* Robust estimator of mean and SD. */
/* Idea: exclude high/low tails of data, and adjust computed */
/* mean and SD heuristically. */
/* Note: unknown and N/A values must be removed and cases must be */
/* sorted by ClassAtt before calling TrimmedSDEstimate. */
/* */
/*************************************************************************/
void TrimmedSDEstimate(CaseNo Fp, CaseNo Lp, double *Mean, double *SD)
/* ----------------- */
{
CaseNo i, Tail, Cases, Quart;
double Val, Sum=0, SumSq=0;
/* Set defaults */
*Mean = 0;
*SD = 1E38;
Tail = MaxAnoms(No(Fp, Lp));
Cases = No(Fp, Lp) - 2 * Tail;
Quart = No(Fp, Lp) / 4;
/* Don't try to estimate if too many values are the same */
if ( CClass(Case[Fp+Quart]) == CClass(Case[Lp-Quart]) )
{
return;
}
ForEach(i, Fp+Tail, Lp-Tail)
{
if ( NotApplic(Case[i], ClassAtt) )
{
Cases--;
}
else
{
Val = CClass(Case[i]);
Sum += Val;
SumSq += Val * Val;
}
}
if ( Cases < Tail )
{
return;
}
/* If there are N cases (excluding non-applicables) then adjust
SD by factor (N + Tail) / (N - Tail) */
*Mean = Sum / Cases;
*SD = SDEstimate(Cases, Sum, SumSq) *
(Cases + 3.0 * Tail ) / (Cases + Tail);
}
/*************************************************************************/
/* */
/* Find a tail containing potential anomalies between Fp and Lp-1. */
/* * case Lp must have a Z-score <= MAXNORM */
/* * there must be a gap >= MINABNORM-MAXNORM between the anomalous */
/* and non-anomalous values */
/* * the cluster cannot contain cases from omitted tails */
/* */
/*************************************************************************/
CaseNo FindTail(CaseNo Fp, CaseNo Lp, int I, double Mean, double SD)
/* -------- */
{
CaseNo i;
double Z;
if ( ZScore(Lp) > MAXNORM ) return -1;
/* Find the first gap */
for ( i = Lp ; i * I > Fp * I && (Z = ZScore(i)) <= MINABNORM ; i -= I )
{
if ( ZScore(i - I) - Z >= MINABNORM - MAXNORM )
{
break;
}
}
return ( Z > MINABNORM ? -1 : OmittedCases(I) ? -1 : i - I );
}
/*************************************************************************/
/* */
/* Check whether the current cluster includes cases from the */
/* excluded high/low tails */
/* */
/*************************************************************************/
Boolean OmittedCases(int HiLo)
/* ------------ */
{
CaseNo Fp, Lp;
CaseNo i;
if ( HiLo > 0 )
{
Fp = LowFp;
Lp = LowLp;
}
else
{
Fp = HighFp;
Lp = MaxCase;
}
ForEach(i, Fp, Lp)
{
if ( SatisfiesTests(Case[i]) )
{
return true;
}
}
return false;
}
/*************************************************************************/
/* */
/* See whether a case satisfies all current tests */
/* */
/*************************************************************************/
Boolean SatisfiesTests(Description Case)
/* -------------- */
{
Attribute Att;
DiscrValue Br;
int i;
ForEach(i, 0, GEnv.Level)
{
Att = GEnv.Test[i].Att;
Br = GEnv.Test[i].Br;
if ( Unknown(Case, Att) )
{
return false;
}
else
if ( Br == 1 )
{
if ( ! NotApplic(Case, Att) ) return false;
}
else
if ( NotApplic(Case, Att) )
{
return false;
}
else
if ( Continuous(Att) )
{
if ( ( Br == 2 ) != ( CVal(Case, Att) <= GEnv.Test[i].Cut ) )
{
return false;
}
}
else
if ( Ordered(Att) )
{
if ( ( Br == 2 ) != ( DVal(Case, Att) <= GEnv.Test[i].Cut ) )
{
return false;
}
}
else
if ( Continuous(ClassAtt) && MaxAttVal[Att] > 3 )
{
if ( ( Br == 2 ) != ( In(DVal(Case, Att), GEnv.Test[i].Left) != 0 ) )
{
return false;
}
}
else
if ( Br != DVal(Case, Att) )
{
return false;
}
}
return true;
}
/*************************************************************************/
/* */
/* Check discrete values of ClassAtt for cases Fp to Lp */
/* Idea: anomaly will appear as an odd case in nearly-pure subset */
/* */
/*************************************************************************/
void FindDiscrOutliers(CaseNo Fp, CaseNo Lp, CaseCount *Table)
/* ----------------- */
{
DiscrValue v, Majority=1;
CaseNo i, GFp, GLp;
CaseCount Cases, Anoms;
double X;
Clust C, OldC;
Boolean SomeSurprise=false, NeedCluster;
Cases = No(Fp, Lp);
if ( Cases < DMINITEMS ) return;
if ( ! Table )
{
FindClassFrequencies(Fp, Lp);
Table = GEnv.ClassFreq;
}
ForEach(v, 2, MaxAttVal[ClassAtt])
{
if ( Table[v] > 0 )
{
if ( ! Majority || Table[v] > Table[Majority] )
{
Majority = v;
}
}
}
/* Skip if too many anomalies */
Anoms = Cases - Table[Majority];
if ( Anoms > MaxAnoms(Cases) )
{
return;
}
/* Check whether any non-majority class is surprising */
for ( v = 1 ; ! SomeSurprise && v <= MaxAttVal[ClassAtt] ; v++ )
{
if ( v == Majority ) continue;
X = XDScore(Table[v], Cases, Anoms, Prior[ClassAtt][v]);
SomeSurprise = ( X <= 1.0 / (MINABNORM * MINABNORM) );
}
if ( ! SomeSurprise ) return;
if ( SIFT )
{
SaveDiscrCluster(Majority, Anoms, Cases, Table);
}
if ( ! Anoms )
{
if ( SIFT )
{
ExtendSiftEntry("\n");
}
return;
}
/* Need a new cluster if surprising non-zero frequencies */
NeedCluster = ( Table[--v] > 0 );
while ( ! NeedCluster && ++v <= MaxAttVal[ClassAtt] )
{
if ( v == Majority || ! Table[v] ) continue;
X = XDScore(Table[v], Cases, Anoms, Prior[ClassAtt][v]);
NeedCluster = ( X <= 1.0 / (MINABNORM * MINABNORM) );
}
if ( NeedCluster )
{
/* Move all majority-class cases to the front */
GFp = Fp;
GLp = (Fp = Group(ClassAtt, Majority, Fp, Lp, 0.0, Nil)) - 1;
C = NewClust(Majority, 0.0, 0.0, Anoms, Cases);
/* Remove cases whose surprise value is insufficient or
that already have a more interesting recorded anomalous value */
ForEach(i, Fp, Lp)
{
v = DClass(Case[i]);
X = DScore(Cases, Anoms, Prior[ClassAtt][v]);
if ( X > 1.0 / (MINABNORM * MINABNORM) ||
(OldC = OutClust(Case[i])) &&
( C->NCond > OldC->NCond ||
C->NCond == OldC->NCond && X > OutXVal(Case[i]) ) )
{
Swap(i, Fp);
Fp++;
}
}
/* Remove possible anomalies that are non consistent with the
ordinary cases */
Fp = NoOtherDifference(Fp, Lp, GFp, GLp);
/* Finally, record remaining cases */
if ( Fp <= Lp )
{
ForEach(i, Fp, Lp)
{
v = DClass(Case[i]);
X = DScore(Cases, Anoms, Prior[ClassAtt][v]);
Verbosity(1,
fprintf(Of, "****\tpotential outlier %s (p=%.3f) %s\n",
AttValName[ClassAtt][DClass(Case[i])], X,
( LabelAtt ? SVal(Case[i], LabelAtt) : "" )))
RecordOutlier(i, C, X);
}
}
}
if ( SIFT && SomeSurprise )
{
ExtendSiftEntry("\n");
}
}
/*************************************************************************/
/* */
/* Cases Fp through Lp have been identified as potential anoms */
/* in the cluster whose "normal" cases are GFp thrrough GLp. */
/* Discard potential anomalies that appear to be inconsistent */
/* with the normals on some other attribute. */
/* If SIFT is set, record any caveats for the current cluster */
/* */
/*************************************************************************/
CaseNo NoOtherDifference(CaseNo Fp, CaseNo Lp, CaseNo GFp, CaseNo GLp)
/* ----------------- */
{
Attribute Att;
double Sum, SumSq, Mean, SD, CV;
CaseNo i, Cases, GCases;
DiscrValue v;
Boolean Caveat;
int Bytes;
char SE[100];
if ( GEnv.Level < 0 ||
Fp > Lp || (GCases = No(GFp, GLp)) < MINCONTEXT ) return Fp;
/* Use a sample if there are many normal cases */
if ( GCases > MaxDiscrVal * SAMPLEUNIT )
{
GCases = 0.5 * MaxDiscrVal * SAMPLEUNIT;
Sample(GFp, GLp, GCases);
GLp = GFp + GCases - 1;
}
ForEach(Att, 1, MaxAtt)
{
if ( Att == ClassAtt || Exclude(Att) ) continue;
if ( Fp > Lp ) return Fp;
Caveat = false;
if ( Continuous(Att) )
{
/* Find mean and variance of ordinary cases */
Sum = SumSq = Cases = 0;
ForEach(i, GFp, GLp)
{
if ( ! Unknown(Case[i], Att) && ! NotApplic(Case[i], Att) )
{
CV = ( UseLogs[Att] ? log(CVal(Case[i], Att)) :
CVal(Case[i], Att) );
Sum += CV;
SumSq += CV * CV;
Cases++;
}
}
/* Check that sufficient cases to give reliable SD */
if ( Cases >= MINCONTEXT )
{
Mean = Sum / Cases;
SD = SDEstimate(Cases, Sum, SumSq);
/* Move filtered cases to the front */
ForEach (i, Fp, Lp)
{
if ( ! Unknown(Case[i], Att) &&
! NotApplic(Case[i], Att) &&
fabs(Mean -
( UseLogs[Att] ? log(CVal(Case[i], Att)) :
CVal(Case[i], Att) ))
/ SD > MAXNORM )
{
Verbosity(2,
fprintf(Of, "\t %d: difference %s %.2f SD\n",
i, AttName[Att],
(Mean -
( UseLogs[Att] ? log(CVal(Case[i], Att)) :
CVal(Case[i], Att) )) / SD))
Swap(i, Fp);
Fp++;
/* Record possible caveat */
if ( SIFT && ! Caveat )
{
Caveat = true;
sprintf(SE, " %d", Att);
ExtendSiftEntry(SE);
if ( UseLogs[Att] )
{
sprintf(SE, " %.8g %.8g",
exp(Mean - MAXNORM * SD),
exp(Mean + MAXNORM * SD));
}
else
{
sprintf(SE, " %.8g %.8g",
Mean - MAXNORM * SD,
Mean + MAXNORM * SD);
}
ExtendSiftEntry(SE);
}
}
}
}
}
else
{
/* Discrete attribute
NB: This doesn't differentiate between ordered and unordered
discrete attributes -- perhaps it should */
ForEach(v, 0, MaxAttVal[Att])
{
GEnv.ValFreq[v] = 0;
}
ForEach(i, GFp, GLp)
{
GEnv.ValFreq[XDVal(Case[i], Att)]++;
}
/* A discrete attribute value is judged to inconsistent with
the normals if its Laplace probability in the normals is
less than 0.025 and its prior greater than 0.25 */
Bytes = (MaxAttVal[Att]>>3) + 1;
ClearBits(Bytes, GEnv.Subset[0]);
ForEach(i, Fp, Lp)
{
v = XDVal(Case[i], Att);
if ( Prior[Att][v] >= 0.25 &&
(GEnv.ValFreq[v] + 1) / (double) (GCases + 2) < 0.025L )
{
Verbosity(2,
fprintf(Of, "\t %d: difference %s=%s (%d/%d)\n",
i, AttName[Att], AttValName[Att][v],
GEnv.ValFreq[v], GCases))
Swap(i, Fp);
Fp++;
SetBit(v, GEnv.Subset[0]);
Caveat = true;
}
}
if ( SIFT && Caveat )
{
sprintf(SE, " %d", Att);
ExtendSiftEntry(SE);
ForEach(v, 0, Bytes-1)
{
sprintf(SE, " %x", GEnv.Subset[0][v]);
ExtendSiftEntry(SE);
}
}
}
}
return Fp;
}
cluster.c 0000664 0000764 0000764 00000016406 11501534524 012624 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Routines to manage clusters */
/* --------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
/*************************************************************************/
/* */
/* Register a new cluster */
/* */
/*************************************************************************/
Clust NewClust(ContValue Expect, ContValue SD, ContValue Limit,
CaseCount Anoms, CaseCount GpSize)
/* -------- */
{
Clust C;
/* Make sure we have room for another */
if ( NClust >= ClustSpace )
{
Realloc(Cluster, (ClustSpace += 1000), Clust);
}
C = Cluster[NClust++] = Alloc(1, ClustRec);
/* Save cluster information */
C->Att = ClassAtt;
C->Expect = Expect;
C->SD = SD;
C->Limit = Limit;
C->GpSize = GpSize;
C->Frac = 1 - Anoms / (float) GpSize;
SaveClustConds(C);
return C;
}
/*************************************************************************/
/* */
/* Process current tests to determine cluster conditions. */
/* Different functions are called depending on the condition */
/* type. */
/* */
/*************************************************************************/
void SaveClustConds(Clust C)
/* -------------- */
{
Attribute Att, NAtts=0;
int NC=0;
/* Count attributes tested */
ForEach(Att, 1, MaxAtt)
{
if ( GEnv.Tested[Att] ) NAtts++;
}
C->NCond = NAtts;
C->Cond = Alloc(C->NCond, ClustCond);
/* Format tests on each attribute */
ForEach(Att, 1, MaxAtt)
{
if ( GEnv.Tested[Att] )
{
if ( Continuous(Att) )
{
FormatContinCond(Att, &C->Cond[NC]);
}
else
if ( Ordered(Att) )
{
FormatOrderedCond(Att, &C->Cond[NC]);
}
else
if ( Continuous(ClassAtt) && MaxAttVal[Att] > 3 )
{
FormatSubsetCond(Att, &C->Cond[NC]);
}
else
{
FormatValCond(Att, &C->Cond[NC]);
}
NC++;
}
}
}
/*************************************************************************/
/* */
/* Test on a continuous att. Check all threshold tests */
/* and assemble lowest and highest possible value */
/* */
/*************************************************************************/
void FormatContinCond(Attribute Att, ClustCond *CC)
/* ---------------- */
{
ContValue Lo=-MARKER, Hi=MARKER;
int i, Type=0;
ForEach(i, 0, GEnv.Level)
{
if ( GEnv.Test[i].Att == Att )
{
if ( GEnv.Test[i].Br == 1 )
{
Type = CONT_NA;
Lo = 1;
Hi = 0;
break;
}
else
if ( GEnv.Test[i].Br == 2 )
{
Type |= CONT_LT;
Hi = GEnv.Test[i].Cut;
}
else
{
Type |= CONT_GT;
Lo = GEnv.Test[i].Cut;
}
}
}
CC->Type = Type;
CC->Att = Att;
CC->Low = Lo;
CC->High = Hi;
CC->Values = Nil;
}
/*************************************************************************/
/* */
/* Test on an ordered discrete attribute (similar to above) */
/* */
/*************************************************************************/
void FormatOrderedCond(Attribute Att, ClustCond *CC)
/* ----------------- */
{
DiscrValue Lo, Hi;
int i, Type=0;
Lo = 2;
Hi = MaxAttVal[Att];
ForEach(i, 0, GEnv.Level)
{
if ( GEnv.Test[i].Att == Att )
{
if ( GEnv.Test[i].Br == 1 )
{
Type = DISCR_VAL;
Lo = Hi = 1;
break;
}
else
if ( GEnv.Test[i].Br == 2 )
{
Type |= DISCR_LT;
Hi = GEnv.Test[i].Cut;
}
else
{
Type |= DISCR_GT;
Lo = GEnv.Test[i].Cut + 1;
}
}
}
CC->Type = Type;
CC->Att = Att;
CC->Low = Lo;
CC->High = Hi;
CC->Values = Nil;
}
/*************************************************************************/
/* */
/* Subset test for a discrete attribute. All tests must be */
/* checked to determine the final subset values */
/* */
/*************************************************************************/
void FormatSubsetCond(Attribute Att, ClustCond *CC)
/* ---------------- */
{
DiscrValue v;
int i;
CC->Att = Att;
GEnv.Possible[1] = false;
ForEach(v, 2, MaxAttVal[Att])
{
GEnv.Possible[v] = true;
}
ForEach(i, 0, GEnv.Level)
{
if ( GEnv.Test[i].Att == Att )
{
if ( GEnv.Test[i].Br == 1 )
{
GEnv.Possible[1] = true;
ForEach(v, 2, MaxAttVal[Att])
{
GEnv.Possible[v] = false;
}
break;
}
else
ForEach(v, 2, MaxAttVal[Att])
{
if ( In(v, GEnv.Test[i].Left) )
{
GEnv.Possible[v] = GEnv.Possible[v] && ( GEnv.Test[i].Br == 2 );
}
else
{
GEnv.Possible[v] = GEnv.Possible[v] && ( GEnv.Test[i].Br == 3 );
}
}
}
}
CC->Type = DISCR_SET;
CC->Low = CC->High = 0;
CC->Values = AllocZero((MaxAttVal[Att]>>3)+1, unsigned char);
ForEach(v, 1, MaxAttVal[Att])
{
if ( GEnv.Possible[v] ) SetBit(v, CC->Values);
}
}
/*************************************************************************/
/* */
/* Simple test on attribute value. There is no need to check */
/* more than one test since the first determines the tested value */
/* */
/*************************************************************************/
void FormatValCond(Attribute Att, ClustCond *CC)
/* ------------- */
{
int i;
ForEach(i, 0, GEnv.Level)
{
if ( GEnv.Test[i].Att == Att )
{
CC->Type = DISCR_VAL;
CC->Att = Att;
CC->Low = CC->High = GEnv.Test[i].Br;
CC->Values = Nil;
return;
}
}
}
/*************************************************************************/
/* */
/* Free conditions stored in a cluster */
/* */
/*************************************************************************/
void FreeClust(Clust C)
/* --------- */
{
int d;
if ( C )
{
ForEach(d, 0, C->NCond-1)
{
FreeUnlessNil(C->Cond[d].Values);
}
FreeUnlessNil(C->Cond);
Free(C);
}
}
common.c 0000664 0000764 0000764 00000064500 11501534524 012431 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
#ifndef INSPECT
/*************************************************************************/
/* */
/* Divide-and-Conquer generic routines */
/* ----------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
/*************************************************************************/
/* */
/* Allocate space for all tables */
/* */
/*************************************************************************/
void InitialiseDAC()
/* ------------- */
{
DiscrValue v;
Attribute Att;
CaseNo i, MaxSampleSize;
extern SortPair *Pair;
UseLogs = AllocZero(MaxAtt+1, Boolean);
SomeMiss = AllocZero(MaxAtt+1, Boolean);
SomeNA = AllocZero(MaxAtt+1, Boolean);
LowTail = AllocZero(MaxAtt+1, ContValue);
HighTail = AllocZero(MaxAtt+1, ContValue);
LogCaseNo = Alloc(MaxCase+2, double);
LogCaseNo[0] = LogCaseNo[1] = 0;
ForEach(i, 2, MaxCase+1)
{
LogCaseNo[i] = log((double) i) / Log2;
}
/* Save random numbers for sampling */
MaxSampleSize = SAMPLEUNIT * Max(MaxDiscrVal, 5);
if ( MaxSampleSize > (MaxCase+1) / 2 + 1 )
{
MaxSampleSize = (MaxCase+1) / 2 + 1;
}
Rand = Alloc(MaxSampleSize, double);
ResetKR(1230);
ForEach(i, 0, MaxSampleSize-1)
{
Rand[i] = KRandom();
}
/* Compute prior probabilities for discrete values */
Prior = Alloc(MaxAtt+1, double *);
ForEach(Att, 1, MaxAtt)
{
if ( Discrete(Att) )
{
Prior[Att] = AllocZero(MaxAttVal[Att]+1, double);
ForEach(i, 0, MaxCase)
{
Prior[Att][XDVal(Case[i], Att)]++;
}
SomeMiss[Att] = ( Prior[Att][0] > 0 );
SomeNA[Att] = ( Prior[Att][1] > 0 );
ForEach(v, 0, MaxAttVal[Att])
{
Prior[Att][v] /= (double) (MaxCase+1);
}
}
}
/* Determine precision for continuous attributes */
Prec = AllocZero(MaxAtt+1, unsigned char);
ForEach(Att, 1, MaxAtt)
{
if ( ! Exclude(Att) && Continuous(Att) )
{
Prec[Att] = log(FracBase(Att)) / log(10.0) + 0.5;
}
}
Pair = Alloc(MaxCase+1, SortPair);
InitialiseEnvData();
}
void FreeDAC()
/* ------- */
{
extern SortPair *Pair;
FreeEnvData();
FreeUnlessNil(UseLogs); UseLogs = Nil;
FreeUnlessNil(SomeMiss); SomeMiss = Nil;
FreeUnlessNil(SomeNA); SomeNA = Nil;
FreeUnlessNil(LowTail); LowTail = Nil;
FreeUnlessNil(HighTail); HighTail = Nil;
FreeUnlessNil(LogCaseNo); LogCaseNo = Nil;
FreeUnlessNil(Rand); Rand = Nil;
FreeVector((void **) Prior, 1, MaxAtt); Prior = Nil;
FreeUnlessNil(Prec); Prec = Nil;
FreeUnlessNil(Pair); Pair = Nil;
}
/*************************************************************************/
/* */
/* Split cases Fp through Lp */
/* CondAtts is the current number of conditioning attributes */
/* */
/*************************************************************************/
void Split(CaseNo Fp, CaseNo Lp, int CondAtts, Tree Parent, DiscrValue Br,
Tree *Result)
/* ----- */
{
CaseNo i;
CaseCount Cases;
DiscrValue v;
double Val, Sum=0, SumSq=0;
Attribute Att, BestAtt;
Tree Node;
*Result = Nil;
/* Recover info about tests to this point */
ForEach(Att, 1, MaxAtt)
{
GEnv.Tested[Att] = 0;
}
RecoverContext(Parent, Br);
Cases = No(Fp, Lp);
Verbosity(1,
fprintf(Of, "\n<%d> %d cases %d-%d\n", GEnv.Level, Cases, Fp, Lp);
ShowContext(Fp))
GEnv.FRAC = 1;
/* Determine PSD and base information. This is only approximate, since
missing values of the tested attributes are excluded. */
if ( Continuous(ClassAtt) )
{
if ( Cases < 2 * CMINITEMS )
{
Progress(Cases);
return;
}
ForEach(i, Fp, Lp)
{
Val = CClass(Case[i]);
Sum += Val;
SumSq += Val * Val;
}
GEnv.PSD = SDEstimate(Cases, Sum, SumSq);
}
else
{
if ( Cases < 2 * DMINITEMS )
{
Progress(Cases);
return;
}
/* Check for pure leaf */
FindClassFrequencies(Fp, Lp);
ForEach(v, 1, MaxAttVal[ClassAtt])
{
if ( GEnv.ClassFreq[v] == Cases )
{
Verbosity(1, fprintf(Of, "\tpure subset\n"))
Progress(Cases);
return;
}
}
GEnv.BaseInfo =
TotalInfo(GEnv.ClassFreq, 1, MaxAttVal[ClassAtt]) / Cases;
}
*Result = Node = Leaf(Parent, Br);
/* Find the best attribute split, using sampling if the number
of cases is at least the minimum multiple of the sample size.
Start by collecting info on discrete attributes */
DiscreteAttInfo(Fp, Lp, CondAtts);
if ( Cases > SAMPLEFACTOR * SampleSize )
{
ChooseSplitWithSampling(Fp, Lp, CondAtts);
}
else
{
ChooseSplit(Fp, Lp, CondAtts);
}
/* Save any sift entry */
if ( SIFT && GEnv.SiftEntry && GEnv.SiftSize )
{
Node->SiftEntry = strdup(GEnv.SiftEntry);
GEnv.SiftSize = 0;
}
FindBestAtt(&BestAtt, &Val);
/* Decide whether to branch or not */
if ( BestAtt == None )
{
Verbosity(1, fprintf(Of, "\tno sensible splits\n"))
Progress(Cases);
}
else
{
Verbosity(1,
fprintf(Of, "\tbest attribute %s", AttName[BestAtt]);
if ( Continuous(BestAtt) )
{
fprintf(Of, " cut %.3f", GEnv.Bar[BestAtt]);
}
if ( ! Continuous(ClassAtt) )
{
fprintf(Of, " val %.3f inf %.3f",
SplitVal(GEnv.Gain[BestAtt], GEnv.Info[BestAtt]),
GEnv.Info[BestAtt]);
}
fprintf(Of, " gain %.3f\n", GEnv.Gain[BestAtt]);)
/* Carry out the recursive divide-and-conquer */
Node->Tested = BestAtt;
if ( Continuous(BestAtt) || Ordered(BestAtt) )
{
Node->NodeType = BrThresh;
Node->Forks = 3;
Node->Cut = GEnv.Bar[BestAtt];
}
else
if ( Continuous(ClassAtt) && MaxAttVal[BestAtt] > 3 )
{
Node->NodeType = BrSubset;
Node->Forks = 3;
Node->Left = Alloc((MaxAttVal[BestAtt]>>3)+1, unsigned char);
memcpy(Node->Left, GEnv.Subset[BestAtt], (MaxAttVal[BestAtt]>>3)+1);
}
else
{
Node->NodeType = BrDiscr;
Node->Forks = MaxAttVal[BestAtt];
}
Node->Branch = Alloc(Node->Forks+1, Tree);
if ( ! GEnv.Tested[BestAtt] ) CondAtts++;
Divide(Node, Fp, Lp, CondAtts);
}
}
/*************************************************************************/
/* */
/* Recover information on level and tests from tree and parent */
/* */
/*************************************************************************/
void RecoverContext(Tree T, DiscrValue Br)
/* -------------- */
{
if ( T )
{
RecoverContext(T->Parent, T->Br);
NoteTest(T->Tested, Br, T->Cut, T->Left);
GEnv.Tested[T->Tested]++;
GEnv.Level++;
}
else
{
GEnv.Level = 0;
}
}
/*************************************************************************/
/* */
/* Analyse all discrete attributes in one pass */
/* */
/*************************************************************************/
void DiscreteAttInfo(CaseNo Fp, CaseNo Lp, int CondAtts)
/* --------------- */
{
CaseNo i;
DiscrValue v, c;
Attribute Att;
double Val;
int NDList=0, dl;
/* Initialise counts etc and prepare list of attributes */
ForEach(Att, 1, MaxAtt)
{
if ( ! Discrete(Att) || Exclude(Att) || Att == ClassAtt ||
CondAtts >= MAXCONDATTS && ! GEnv.Tested[Att] )
{
continue;
}
GEnv.DList[NDList++] = Att;
if ( Continuous(ClassAtt) )
{
ForEach(v, 0, MaxAttVal[Att])
{
GEnv.DValSum[Att][v] = GEnv.DValSumSq[Att][v] = 0;
GEnv.DFreq[Att][v][0] = 0; /* value frequency */
}
}
else
{
ForEach(v, 0, MaxAttVal[Att])
{
ForEach(c, 1, MaxAttVal[ClassAtt])
{
GEnv.DFreq[Att][v][c] = 0;
}
}
}
}
if ( ! NDList-- ) return;
/* Examine cases and update all counts etc */
ForEach(i, Fp, Lp)
{
ForEach(dl, 0, NDList)
{
Att = GEnv.DList[dl];
v = XDVal(Case[i], Att);
if ( Continuous(ClassAtt) )
{
Val = CClass(Case[i]);
GEnv.DFreq[Att][v][0]++;
GEnv.DValSum[Att][v] += Val;
GEnv.DValSumSq[Att][v] += Val * Val;
}
else
{
GEnv.DFreq[Att][v][ DClass(Case[i]) ]++;
}
}
}
}
/*************************************************************************/
/* */
/* Choose split using a sample. There are three phases: */
/* - process discrete atts using all data */
/* - for continuous atts, find gain etc from two samples and */
/* record the better value */
/* - re-examine high-value continuous attributes using all cases */
/* */
/*************************************************************************/
void ChooseSplitWithSampling(CaseNo Fp, CaseNo Lp, int CondAtts)
/* ----------------------- */
{
double Val, OldBestVal;
Attribute Att, BestAtt;
/* Process discrete attributes using all data */
ForEach(Att, 1, MaxAtt)
{
GEnv.Gain[Att] = None;
if ( Exclude(Att) || Att == ClassAtt || Continuous(Att) ||
CondAtts >= MAXCONDATTS && ! GEnv.Tested[Att] )
{
continue;
}
CheckSplit(Att, Fp, Lp);
}
/* Process continuous attributes using two samples */
GEnv.FRAC = SampleSize / (double) No(Fp, Lp);
SampleScan(Fp, Lp, CondAtts, false);
SampleScan(Fp+SampleSize, Lp, CondAtts, true);
GEnv.FRAC = 1;
/* Re-examine continuous attributes that are possible best splits
(with value at least 70% of current best value) */
FindBestAtt(&BestAtt, &OldBestVal);
if ( BestAtt != None )
{
Verbosity(2,
fprintf(Of, " Revisit threshold %.3f (%s)\n",
0.7 * OldBestVal, AttName[BestAtt]))
ForEach(Att, 1, MaxAtt)
{
if ( Discrete(Att) || GEnv.Gain[Att] <= Epsilon ) continue;
Val = SplitVal(GEnv.Gain[Att], GEnv.Info[Att]);
GEnv.Gain[Att] = None;
if ( Val > 0.7 * OldBestVal )
{
CheckSplit(Att, Fp, Lp);
}
}
}
}
/*************************************************************************/
/* */
/* Estimate Gain etc of continuous attributes using sample */
/* */
/*************************************************************************/
void SampleScan(CaseNo Fp, CaseNo Lp, int CondAtts, Boolean Second)
/* ---------- */
{
CaseNo i, SLp;
double Val, Sum=0, SumSq=0, SaveBaseInfo, SavePSD,
FBar, FInfo, FGain, FVal;
Attribute Att;
/* Save base information or SD */
SaveBaseInfo = GEnv.BaseInfo;
SavePSD = GEnv.PSD;
/* Generate sample in Fp ... Fp+SampleSize-1 */
Sample(Fp, Lp, SampleSize);
SLp = Fp + SampleSize - 1;
/* Determine sample PSD or base information */
if ( Continuous(ClassAtt) )
{
ForEach(i, Fp, SLp)
{
Val = CClass(Case[i]);
Sum += Val;
SumSq += Val * Val;
}
GEnv.PSD = SDEstimate(SampleSize, Sum, SumSq);
}
else
{
FindClassFrequencies(Fp, SLp);
GEnv.BaseInfo =
TotalInfo(GEnv.ClassFreq, 1, MaxAttVal[ClassAtt]) / SampleSize;
}
/* Check attributes using sample */
ForEach(Att, 1, MaxAtt)
{
if ( Exclude(Att) || Att == ClassAtt || ! Continuous(Att) ||
CondAtts >= MAXCONDATTS && ! GEnv.Tested[Att] )
{
continue;
}
/* Save information from possible earlier sample */
FInfo = GEnv.Info[Att];
FGain = GEnv.Gain[Att];
FBar = GEnv.Bar[Att];
GEnv.Gain[Att] = None;
CheckSplit(Att, Fp, SLp);
/* If this is second sample, retain information from better */
if ( Second )
{
FVal = SplitVal(FGain, FInfo); /* first value */
Val = SplitVal(GEnv.Gain[Att], GEnv.Info[Att]); /* second value */
if ( FVal > Val )
{
GEnv.Gain[Att] = FGain;
GEnv.Info[Att] = FInfo;
GEnv.Bar[Att] = FBar;
}
}
}
/* Restore base information or SD */
GEnv.BaseInfo = SaveBaseInfo;
GEnv.PSD = SavePSD;
}
/*************************************************************************/
/* */
/* Sample N cases from Fp through Lp using tabulated random nos */
/* */
/*************************************************************************/
void Sample(CaseNo Fp, CaseNo Lp, CaseCount N)
/* ------ */
{
CaseNo i, j, Cases;
Cases = No(Fp, Lp);
ForEach(i, 0, N-1)
{
j = Rand[i] * Cases--;
Swap(Fp+i, Fp+j);
}
}
/*************************************************************************/
/* */
/* Choose a split using all cases */
/* */
/*************************************************************************/
void ChooseSplit(CaseNo Fp, CaseNo Lp, int CondAtts)
/* ----------- */
{
Attribute Att;
GEnv.FRAC = 1;
ForEach(Att, 1, MaxAtt)
{
GEnv.Gain[Att] = None;
if ( Exclude(Att) || Att == ClassAtt ||
CondAtts >= MAXCONDATTS && ! GEnv.Tested[Att] )
{
continue;
}
CheckSplit(Att, Fp, Lp);
}
}
void FindBestAtt(Attribute *BestAtt, double *BestVal)
/* ----------- */
{
Attribute Att;
double Val;
*BestVal = Epsilon;
*BestAtt = None;
ForEach(Att, 1, MaxAtt)
{
Val = SplitVal(GEnv.Gain[Att], GEnv.Info[Att]);
if ( Val > *BestVal )
{
*BestAtt = Att;
*BestVal = Val;
}
}
}
/*************************************************************************/
/* */
/* Evaluate a potential split */
/* */
/*************************************************************************/
void CheckSplit(Attribute Att, CaseNo Fp, CaseNo Lp)
/* ---------- */
{
CaseNo Xp;
GEnv.Tested[Att]++;
/* Remove missing values of Att. Note: this makes values
of BaseInfo and PSD approximate only */
Xp = ( SomeMiss[Att] ? SkipMissing(Att, Fp, Lp) : Fp );
/* Evaluate attribute for split -- different methods for
continuous and discrete class attributes */
if ( Continuous(Att) ) /* continuous att */
{
if ( Continuous(ClassAtt) )
{
CEvalContinAtt(Att, Xp, Lp);
}
else
{
DEvalContinAtt(Att, Xp, Lp);
}
}
else /* discrete att */
{
if ( Continuous(ClassAtt) )
{
if ( MaxAttVal[Att] > 3 || GEnv.Tested[Att] <= 1 )
{
CEvalDiscrAtt(Att, Xp, Lp);
}
}
else
if ( Ordered(Att) )
{
DEvalOrderedAtt(Att, Xp, Lp);
}
else
if ( GEnv.Tested[Att] <= 1 )
{
DEvalDiscrAtt(Att, Xp, Lp);
}
}
if ( GEnv.Gain[Att] > Epsilon )
{
/* Find value adjusted for missing values */
GEnv.Gain[Att] *= No(Xp, Lp) / (double) No(Fp, Lp);
GEnv.Info[Att] = Max(GEnv.Info[Att], 0.5);
}
GEnv.Tested[Att]--;
}
/*************************************************************************/
/* */
/* Split cases Fp to Lp on attribute Att */
/* */
/*************************************************************************/
void Divide(Tree Node, CaseNo Fp, CaseNo Lp, int CondAtts)
/* ------ */
{
CaseNo Ep;
DiscrValue v;
/* Remove unknown attribute values */
Ep = ( SomeMiss[Node->Tested] ? SkipMissing(Node->Tested, Fp, Lp) : Fp );
Progress(Ep - Fp);
/* Recursive divide and conquer */
ForEach(v, 1, Node->Forks)
{
Fp = Ep;
Ep = Group(Node->Tested, v, Fp, Lp, Node->Cut, Node->Left);
if ( Ep > Fp )
{
Split(Fp, Ep-1, CondAtts, Node, v, &Node->Branch[v]);
}
}
}
/*************************************************************************/
/* */
/* Group together missing values and return index of next case */
/* */
/*************************************************************************/
CaseNo SkipMissing(Attribute Att, CaseNo Fp, CaseNo Lp)
/* ----------- */
{
CaseNo i;
ForEach(i, Fp, Lp)
{
if ( Unknown(Case[i], Att) )
{
Swap(Fp, i);
Fp++;
}
}
return Fp;
}
/*************************************************************************/
/* */
/* Check groups formed by a potential test */
/* */
/*************************************************************************/
void CheckPotentialClusters(Attribute Att, DiscrValue Forks,
CaseNo Fp, CaseNo Lp, ContValue Cut, Set S,
CaseNo **FT)
/* ---------------------- */
{
CaseNo Ep;
DiscrValue v;
ForEach(v, 1, Forks)
{
Ep = Group(Att, v, Fp, Lp, Cut, S);
if ( Ep > Fp )
{
NoteTest(Att, v, Cut, S);
if ( Continuous(ClassAtt) )
{
FindContinOutliers(Fp, Ep-1, false);
}
else
{
FindDiscrOutliers(Fp, Ep-1, ( FT ? FT[v] : Nil ));
}
Fp = Ep;
}
}
}
/*************************************************************************/
/* */
/* Print context information for DAC */
/* */
/*************************************************************************/
void ShowContext(CaseNo i)
/* ----------- */
{
Attribute Att;
ClustRec CR;
Clust C=&CR;
int d;
C->Att = ClassAtt;
GEnv.Level--;
SaveClustConds(C);
GEnv.Level++;
ForEach(d, 0, C->NCond-1)
{
Att = C->Cond[d].Att;
if ( Continuous(Att) )
{
PrintContinCond(Att, C->Cond[d].Low, C->Cond[d].High, i);
}
else
if ( Ordered(Att) )
{
PrintOrderedCond(Att, (int) C->Cond[d].Low, (int) C->Cond[d].High,
i);
}
else
if ( Continuous(C->Att) && MaxAttVal[Att] > 3 )
{
PrintSubsetCond(Att, C->Cond[d].Values, i);
FreeUnlessNil(C->Cond[d].Values);
}
else
{
PrintValCond(Att, (int) C->Cond[d].Low);
}
}
Free(C->Cond);
}
/*************************************************************************/
/* */
/* Construct a leaf in a given node */
/* */
/*************************************************************************/
Tree Leaf(Tree Parent, DiscrValue Br)
/* ---- */
{
Tree Node;
Node = AllocZero(1, TreeRec);
Node->NodeType = 0;
Node->Parent = Parent;
Node->Br = Br;
return Node;
}
void ReleaseTree(Tree T, int Level)
/* ----------- */
{
DiscrValue v;
if ( ! T ) return;
if ( Level > 0 && LastLevel >= Level - 1 ) LastLevel = Level - 2;
/* Possible sift entry */
if ( T->SiftEntry )
{
if ( SIFT )
{
RecoverContext(T->Parent, T->Br);
OutputConditions();
fprintf(Sf, "%s", T->SiftEntry);
}
Free(T->SiftEntry);
}
if ( T->NodeType )
{
ForEach(v, 1, T->Forks)
{
ReleaseTree(T->Branch[v], Level+1);
}
if ( T->NodeType == BrSubset )
{
FreeUnlessNil(T->Left);
}
Free(T->Branch);
}
Free(T);
}
void OutputConditions()
/* ---------------- */
{
Attribute Att;
int i, CType, b, Bytes;
DiscrValue Br;
if ( ! TargetSaved )
{
fprintf(Sf, "1 %d\n", ClassAtt);
TargetSaved = true;
}
if ( GEnv.Level < 0 ) return;
/* Save all conditions since last saved */
ForEach(i, LastLevel+1, GEnv.Level-1)
{
Att = GEnv.Test[i].Att;
Br = GEnv.Test[i].Br;
/* Determine condition type */
CType = ( Br == 1 ? 11 :
Continuous(Att) || Ordered(Att) ? 12 :
Continuous(ClassAtt) && MaxAttVal[Att] > 3 ? 13 : 11 );
fprintf(Sf, "%d %d %d %d", CType, i, Att, Br);
/* Don't need to save anything else if this branch is 1 (N/A)
or if test is on two-valued discrete att */
if ( Br != 1 )
{
if ( Continuous(Att) || Ordered(Att) )
{
fprintf(Sf, " %.8g", GEnv.Test[i].Cut);
}
else
if ( Continuous(ClassAtt) && MaxAttVal[Att] > 3 )
{
/* Print subset of values */
Bytes = (MaxAttVal[Att]>>3) + 1;
ForEach(b, 0, Bytes-1)
{
fprintf(Sf, " %x", GEnv.Test[i].Left[b]);
}
}
}
fprintf(Sf, "\n");
}
LastLevel = GEnv.Level-1;
}
/*************************************************************************/
/* */
/* Set up environment */
/* */
/*************************************************************************/
void InitialiseEnvData()
/* ----------------- */
{
DiscrValue v;
Attribute Att;
GEnv.ValFreq = Alloc(MaxDiscrVal+1, CaseCount);
GEnv.ClassFreq = Alloc(MaxDiscrVal+1, CaseCount);
GEnv.ValSum = Alloc(MaxDiscrVal+1, double);
GEnv.ValSumSq = Alloc(MaxDiscrVal+1, double);
GEnv.Left = Alloc(MaxDiscrVal+1, Boolean);
GEnv.Possible = Alloc(MaxDiscrVal+1, Boolean);
GEnv.Tested = AllocZero(MaxAtt+1, int);
GEnv.Gain = AllocZero(MaxAtt+1, double);
GEnv.Info = AllocZero(MaxAtt+1, double);
GEnv.Bar = AllocZero(MaxAtt+1, ContValue);
GEnv.Subset = AllocZero(MaxAtt+1, Set);
GEnv.Subset[0] = Alloc((MaxDiscrVal>>3)+1, unsigned char); /* caveats */
ForEach(Att, 1, MaxAtt)
{
if ( Discrete(Att) )
{
GEnv.Subset[Att] = Alloc((MaxAttVal[Att]>>3)+1, unsigned char);
}
}
/* Freq[] is one longer than apparently necessary to allow for
the extra slot needed by EvalOrderedAtt() */
GEnv.Freq = AllocZero(MaxDiscrVal+2, CaseCount *);
ForEach(v, 0, MaxDiscrVal+1)
{
GEnv.Freq[v] = AllocZero(MaxDiscrVal+1, CaseCount);
}
GEnv.BestFreq = AllocZero(4, CaseCount *);
ForEach(v, 0, 3)
{
GEnv.BestFreq[v] = AllocZero(MaxDiscrVal+1, CaseCount);
}
GEnv.DList = Alloc(MaxAtt+1, Attribute);
GEnv.DFreq = Alloc(MaxAtt+1, CaseCount **);
GEnv.DValSum = Alloc(MaxAtt+1, double *);
GEnv.DValSumSq = Alloc(MaxAtt+1, double *);
ForEach(Att, 1, MaxAtt)
{
if ( Exclude(Att) || ! Discrete(Att) ) continue;
GEnv.DFreq[Att] = Alloc(MaxAttVal[Att]+1, CaseCount *);
ForEach(v, 0, MaxAttVal[Att])
{
GEnv.DFreq[Att][v] = Alloc(MaxDiscrVal+1, CaseCount);
}
GEnv.DValSum[Att] = Alloc(MaxDiscrVal+1, double);
GEnv.DValSumSq[Att] = Alloc(MaxDiscrVal+1, double);
}
}
/*************************************************************************/
/* */
/* Clean up environment */
/* */
/*************************************************************************/
void FreeEnvData()
/* ------------ */
{
Attribute Att;
int i;
if ( ! GEnv.ValFreq ) return;
FreeUnlessNil(GEnv.ValFreq);
FreeUnlessNil(GEnv.ClassFreq);
FreeUnlessNil(GEnv.ValSum);
FreeUnlessNil(GEnv.ValSumSq);
FreeUnlessNil(GEnv.Left);
FreeUnlessNil(GEnv.Possible);
FreeUnlessNil(GEnv.Tested);
FreeUnlessNil(GEnv.Gain);
FreeUnlessNil(GEnv.Info);
FreeUnlessNil(GEnv.Bar);
if ( GEnv.Test )
{
ForEach(i, 0, GEnv.MaxLevel-1)
{
FreeUnlessNil(GEnv.Test[i].Left);
}
Free(GEnv.Test);
}
FreeUnlessNil(GEnv.Subset[0]);
ForEach(Att, 1, MaxAtt)
{
if ( Discrete(Att) )
{
FreeUnlessNil(GEnv.Subset[Att]);
}
}
FreeUnlessNil(GEnv.Subset);
FreeVector((void **) GEnv.Freq, 0, MaxDiscrVal+1);
FreeVector((void **) GEnv.BestFreq, 0, 3);
ForEach(Att, 1, MaxAtt)
{
if ( ! GEnv.DFreq[Att] ) continue;
FreeVector((void **)GEnv.DFreq[Att], 0, MaxAttVal[Att]);
Free(GEnv.DValSum[Att]);
Free(GEnv.DValSumSq[Att]);
}
Free(GEnv.DFreq);
Free(GEnv.DValSum);
Free(GEnv.DValSumSq);
Free(GEnv.DList);
FreeUnlessNil(GEnv.SiftEntry);
}
#endif
/*************************************************************************/
/* */
/* Test[] contains a stack of current tests. Add a new test */
/* for the current level */
/* */
/*************************************************************************/
void NoteTest(Attribute Att, DiscrValue Br, ContValue Cut, Set Left)
/* -------- */
{
int i;
/* Check space for tests */
if ( GEnv.Level >= GEnv.MaxLevel )
{
if ( ! GEnv.MaxLevel )
{
GEnv.Test = Alloc(100, TestRec);
}
else
{
Realloc(GEnv.Test, GEnv.MaxLevel+100, TestRec);
}
ForEach(i, 0, 99)
{
GEnv.Test[GEnv.MaxLevel+i].Left =
Alloc((MaxDiscrVal>>3)+1, unsigned char);
}
GEnv.MaxLevel += 100;
}
GEnv.Test[GEnv.Level].Att = Att;
GEnv.Test[GEnv.Level].Br = Br;
GEnv.Test[GEnv.Level].Cut = Cut;
if ( Left )
{
memcpy(GEnv.Test[GEnv.Level].Left, Left, (MaxAttVal[Att]>>3)+1);
}
}
/*************************************************************************/
/* */
/* Group together the cases corresponding to branch V of a test */
/* and return the index of the case following the last */
/* */
/*************************************************************************/
CaseNo Group(Attribute Att, DiscrValue V, CaseNo Fp, CaseNo Lp,
ContValue Cut, Set Left)
/* ----- */
{
CaseNo i;
/* Group cases on the value of attribute Att, perhaps depending
on the type of split */
if ( V == 1 )
{
/* Group all non-applicable values. Don't even try if
this attribute doesn't have N/A values */
if ( SomeNA[Att] )
{
ForEach(i, Fp, Lp)
{
if ( NotApplic(Case[i], Att) )
{
Swap(Fp, i);
Fp++;
}
}
}
}
else
if ( Continuous(Att) )
{
ForEach(i, Fp, Lp)
{
if ( ! Unknown(Case[i], Att) &&
! NotApplic(Case[i], Att) &&
(CVal(Case[i], Att) <= Cut) == (V == 2) )
{
Swap(Fp, i);
Fp++;
}
}
}
else
if ( Ordered(Att) && Att != ClassAtt )
{
ForEach(i, Fp, Lp)
{
if ( ! Unknown(Case[i], Att) &&
! NotApplic(Case[i], Att) &&
(XDVal(Case[i], Att) <= Cut + 0.1) == (V == 2) )
{
Swap(Fp, i);
Fp++;
}
}
}
else
if ( Continuous(ClassAtt) && MaxAttVal[Att] > 3 )
{
ForEach(i, Fp, Lp)
{
if ( ! Unknown(Case[i], Att) &&
! NotApplic(Case[i], Att) &&
(In(XDVal(Case[i], Att), Left) != 0) == (V == 2) )
{
Swap(Fp, i);
Fp++;
}
}
}
else
{
ForEach(i, Fp, Lp)
{
if ( XDVal(Case[i], Att) == V )
{
Swap(Fp, i);
Fp++;
}
}
}
return Fp;
}
continatt.c 0000664 0000764 0000764 00000023426 11501534524 013146 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Divide-and-Conquer for continuous attributes */
/* -------------------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
/*************************************************************************/
/* */
/* Known values of continuous attributes are divided into */
/* three groups: */
/* (1) N/A */
/* (2) values less than a threshold */
/* (3) values greater than a threshold */
/* This routine finds the best threshold for items Fp through Lp */
/* and sets Gain[] and Bar[] */
/* */
/*************************************************************************/
void CEvalContinAtt(Attribute Att, CaseNo Fp, CaseNo Lp)
/* -------------- */
{
CaseNo i, BestI, Xp;
double Val, ThisGain, BestGain=-1E-6;
/* Special case when very few values */
if ( No(Fp, Lp) < 2 * (CMINITEMS*GEnv.FRAC) )
{
Verbosity(2,
fprintf(Of, "\tAtt %s: insufficient cases with known values\n",
AttName[Att]))
return;
}
GEnv.BrFreq[1] = GEnv.BrFreq[2] = GEnv.BrFreq[3] = 0;
GEnv.BrSum[1] = GEnv.BrSumSq[1] =
GEnv.BrSum[2] = GEnv.BrSumSq[2] =
GEnv.BrSum[3] = GEnv.BrSumSq[3] = 0;
/* Omit and count N/A values and count base values */
Xp = Fp;
ForEach(i, Fp, Lp)
{
Val = CClass(Case[i]);
if ( NotApplic(Case[i],Att) )
{
GEnv.BrFreq[1]++;
GEnv.BrSum[1] += Val;
GEnv.BrSumSq[1] += Val * Val;
Swap(i, Xp);
Xp++;
}
else
{
GEnv.BrFreq[3]++;
GEnv.BrSum[3] += Val;
GEnv.BrSumSq[3] += Val * Val;
}
}
/* Sort all applicable values */
Quicksort(Xp, Lp, Att);
/* Try possible cuts between items i and i+1, and determine the
information and gain of the split in each case */
ForEach(i, Xp, Lp - (CMINITEMS*GEnv.FRAC))
{
Val = CClass(Case[i]);
GEnv.BrFreq[2]++;
GEnv.BrFreq[3]--;
GEnv.BrSum[2] += Val;
GEnv.BrSum[3] -= Val;
GEnv.BrSumSq[2] += Val * Val;
GEnv.BrSumSq[3] -= Val * Val;
if ( CVal(Case[i+1], Att) > CVal(Case[i], Att) &&
i >= Xp+(CMINITEMS*GEnv.FRAC)-1 )
{
ThisGain = ContinGain();
if ( ThisGain > BestGain + Epsilon )
{
BestGain = ThisGain;
BestI = i;
}
}
}
/* Set the best break point and gain */
if ( BestGain > Epsilon )
{
GEnv.Gain[Att] = BestGain;
GEnv.Bar[Att] = Between(CVal(Case[BestI],Att),
CVal(Case[BestI+1],Att));
Verbosity(2,
fprintf(Of, "\tAtt %s: cut=%.3f, gain %.3f\n",
AttName[Att], GEnv.Bar[Att], GEnv.Gain[Att]))
/* If not sampling, check subsets now */
if ( GEnv.FRAC >= 1.0 )
{
if ( Xp > Fp )
{
NoteTest(Att, 1, GEnv.Bar[Att], Nil);
FindContinOutliers(Fp, Xp-1, false);
}
NoteTest(Att, 2, GEnv.Bar[Att], Nil);
FindContinOutliers(Fp, BestI, false);
NoteTest(Att, 3, GEnv.Bar[Att], Nil);
FindContinOutliers(BestI+1, Lp, false);
}
}
else
{
Verbosity(2, fprintf(Of, "\tAtt %s: no gain\n", AttName[Att]))
}
}
/*************************************************************************/
/* */
/* Find the lowest-precision value in the range Low to High */
/* */
/*************************************************************************/
ContValue Between(ContValue Low, ContValue High)
/* ------- */
{
ContValue Base, Unit, Cut, Try, Margin;
if ( Low <= 0 && High > 0 ) return 0.0;
Margin = 0.005L * (High - Low);
Cut = (Low + High) / 2;
/* Try successively smaller units until a threshold lies between
Low and High */
for ( Base = 6 ; Base > -6 ; Base-- )
{
Unit = pow(10.0L, Base);
Try = rint(Cut / Unit) * Unit;
if ( Try >= Low && Try < High - Margin ) return Try;
if ( fmod(Low, Unit) < 1E-6 && fmod(High, Unit) < 1E-6 ) break;
}
/* If all else fails, return the low value */
return Low;
}
/*************************************************************************/
/* */
/* Set Gain[] for discrete partition of items Fp to Lp */
/* */
/*************************************************************************/
void CEvalDiscrAtt(Attribute Att, CaseNo Fp, CaseNo Lp)
/* ------------- */
{
if ( MaxAttVal[Att] == 3 )
{
EvalBinarySplit(Att, Fp, Lp);
}
else
{
EvalSubsetSplit(Att, Fp, Lp);
}
Verbosity(2,
if ( GEnv.Gain[Att] > Epsilon )
{
fprintf(Of, "\tAtt %s: gain %.3f\n", AttName[Att], GEnv.Gain[Att]);
}
else
{
fprintf(Of, "\tAtt %s: no gain\n", AttName[Att]);
})
}
/*************************************************************************/
/* */
/* Special case of binary split */
/* */
/*************************************************************************/
void EvalBinarySplit(Attribute Att, CaseNo Fp, CaseNo Lp)
/* --------------- */
{
DiscrValue v;
ForEach(v, 1, 3)
{
GEnv.BrFreq[v] = GEnv.DFreq[Att][v][0];
GEnv.BrSum[v] = GEnv.DValSum[Att][v];
GEnv.BrSumSq[v] = GEnv.DValSumSq[Att][v];
}
GEnv.Gain[Att] = ContinGain();
if ( GEnv.Gain[Att] < Epsilon ) GEnv.Gain[Att] = None;
if ( GEnv.FRAC >= 1 && GEnv.Gain[Att] > Epsilon )
{
CheckPotentialClusters(Att, 3, Fp, Lp, 0.0, Nil, Nil);
}
}
/*************************************************************************/
/* */
/* Divide attribute values into three subsets (one being N/A) */
/* */
/*************************************************************************/
void EvalSubsetSplit(Attribute Att, CaseNo Fp, CaseNo Lp)
/* --------------- */
{
DiscrValue v, sv, Cycle;
double ThisGain, BestGain=-1E-6;
int Bytes;
ForEach(v, 1, MaxAttVal[Att])
{
GEnv.ValFreq[v] = GEnv.DFreq[Att][v][0];
GEnv.ValSum[v] = GEnv.DValSum[Att][v];
GEnv.ValSumSq[v] = GEnv.DValSumSq[Att][v];
}
GEnv.BrFreq[1] = GEnv.ValFreq[1];
GEnv.BrSum[1] = GEnv.ValSum[1];
GEnv.BrSumSq[1] = GEnv.ValSumSq[1];
ForEach(v, 2, 3)
{
GEnv.BrFreq[v] = GEnv.BrSum[v] = GEnv.BrSumSq[v] = 0;
}
ForEach(v, 2, MaxAttVal[Att])
{
GEnv.BrFreq[2] += GEnv.ValFreq[v];
GEnv.BrSum[2] += GEnv.ValSum[v];
GEnv.BrSumSq[2] += GEnv.ValSumSq[v];
}
/* Examine subsets, starting with all values in the left branch.
At each iteration, move the value with the highest mean from
the left branch to the right branch and check the gain.
(In the case of ordered attributes, the value moved is the
rightmost value in the left branch.)
Save the best gain so far in Subset[Att]. */
ForEach(v, 2, MaxAttVal[Att])
{
GEnv.Left[v] = ( GEnv.ValFreq[v] > 0 );
}
Bytes = (MaxAttVal[Att]>>3) + 1;
ForEach(Cycle, 2, MaxAttVal[Att])
{
if ( Ordered(Att) )
{
for ( sv = MaxAttVal[Att] ; sv > 1 && ! GEnv.Left[sv] ; sv-- )
;
}
else
{
sv = 0;
ForEach(v, 2, MaxAttVal[Att])
{
if ( GEnv.Left[v] &&
( ! sv ||
GEnv.ValSum[v] / GEnv.ValFreq[v] >
GEnv.ValSum[sv] / GEnv.ValFreq[sv] ) )
{
sv = v ;
}
}
}
if ( sv < 2 ) break;
GEnv.Left[sv] = false;
GEnv.BrFreq[2] -= GEnv.ValFreq[sv];
GEnv.BrSum[2] -= GEnv.ValSum[sv];
GEnv.BrSumSq[2] -= GEnv.ValSumSq[sv];
GEnv.BrFreq[3] += GEnv.ValFreq[sv];
GEnv.BrSum[3] += GEnv.ValSum[sv];
GEnv.BrSumSq[3] += GEnv.ValSumSq[sv];
if ( GEnv.BrFreq[2] >= (CMINITEMS*GEnv.FRAC) &&
GEnv.BrFreq[3] >= (CMINITEMS*GEnv.FRAC) &&
(ThisGain = ContinGain()) > BestGain + Epsilon )
{
GEnv.Gain[Att] = BestGain = ThisGain;
GEnv.Bar[Att] = sv-1;
/* Record in Subset[Att] */
ClearBits(Bytes, GEnv.Subset[Att]);
ForEach(v, 2, MaxAttVal[Att])
{
if ( GEnv.Left[v] )
{
SetBit(v, GEnv.Subset[Att]);
}
}
}
}
if ( GEnv.FRAC >= 1 && GEnv.Gain[Att] > Epsilon )
{
CheckPotentialClusters(Att, 3, Fp, Lp, GEnv.Bar[Att], GEnv.Subset[Att],
Nil);
}
}
double SDEstimate(CaseCount N, double Sum, double SumSq)
/* ---------- */
{
return sqrt( (SumSq - Sum * Sum / N + 1E-3) / (N - 1) );
}
/*************************************************************************/
/* */
/* Compute continuous gain for three branches */
/* */
/*************************************************************************/
double ContinGain()
/* ---------- */
{
double Resid=0;
DiscrValue v;
CaseCount Cases=0;
ForEach(v, 1, 3)
{
if ( GEnv.BrFreq[v] > 1 )
{
Cases += GEnv.BrFreq[v];
Resid += GEnv.BrFreq[v] *
SDEstimate(GEnv.BrFreq[v], GEnv.BrSum[v], GEnv.BrSumSq[v]);
}
}
return GEnv.PSD - Resid / Cases;
}
defns.i 0000664 0000764 0000764 00000045143 11501534524 012250 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Definitions */
/* ----------- */
/* */
/*************************************************************************/
#define RELEASE "2.01 GPL Edition"
#include
#include
#include
#include
#include
#include
#include
#include
#include "text.i"
/*************************************************************************/
/* */
/* Definitions dependent on cc options */
/* */
/*************************************************************************/
#define Goodbye(x) exit(x)
#define Of stdout
#include
#ifdef VerbOpt
#include
#define Verbosity(d,s) if(VERBOSITY >= d) {s;}
#define Free(x) {free(x); x = 0;}
#else
#define assert(x)
#define Verbosity(d,s)
#define Free(x) free(x)
#endif
/*************************************************************************/
/* */
/* Constants, macros etc. */
/* */
/*************************************************************************/
#define MAXFRAC 0.01 /* max proportion of outliers in group */
#define MAXNORM 2.67 /* max SDs for non-outlier */
#define MAXTAIL 5.34 /* max SDs for 'ordinary' tail */
#define SAMPLEUNIT 2000 /* min sample per split */
#define SAMPLEFACTOR 5 /* threshold for using sampling */
#define MINCONTEXT 25 /* min cases to detect other difference */
#define Nil 0 /* null pointer */
#define false 0
#define true 1
#define None -1
#define Epsilon 1E-6
#define EXCLUDE 1 /* special attribute status: do not use */
#define SKIP 2 /* do not check */
#define DISCRETE 4 /* ditto: collect values as data read */
#define ORDERED 8 /* ditto: ordered discrete values */
#define DATEVAL 16 /* ditto: YYYY/MM/DD or YYYY-MM-DD */
#define STIMEVAL 32 /* ditto: HH:MM:SS */
#define TSTMPVAL 64 /* date time */
/* unknown and N/A values are represented by
unlikely floating-point numbers
(octal 01600000000 and 01) */
#define UNKNOWN 01600000000 /* 1.5777218104420236e-30 */
#define NA 01 /* 1.4012984643248171e-45 */
#define BrDiscr 1
#define BrThresh 2
#define BrSubset 3
#define AllocZero(N,T) (T *) Pcalloc(N, sizeof(T))
#define Alloc(N,T) AllocZero(N,T) /*for safety */
#define Realloc(V,N,T) V = (T *) Prealloc(V, (N)*sizeof(T))
#define Max(a,b) ((a)>(b) ? a : b)
#define Min(a,b) ((a)<(b) ? a : b)
#define Log2 0.69314718055994530942
#define Bit(b) (1 << (b))
#define In(b,s) ((s[(b) >> 3]) & Bit((b) & 07))
#define ClearBits(n,s) memset(s,0,n)
#define CopyBits(n,f,t) memcpy(t,f,n)
#define SetBit(b,s) (s[(b) >> 3] |= Bit((b) & 07))
#define ResetBit(b,s) (s[(b) >> 3] ^= Bit((b) & 07))
#define ForEach(v,f,l) for(v=f ; v<=l ; ++v)
#define Swap(a,b) {Description _xab; _xab=Case[a]; Case[a]=Case[b]; Case[b]=_xab;}
#define StatBit(a,b) (SpecialStatus[a]&(b))
#define Exclude(a) StatBit(a,EXCLUDE)
#define Skip(a) StatBit(a,EXCLUDE|SKIP)
#define Discrete(a) (MaxAttVal[a] || StatBit(a,DISCRETE))
#define Continuous(a) (! MaxAttVal[a] && ! StatBit(a,DISCRETE))
#define Ordered(a) StatBit(a,ORDERED)
#define DateVal(a) StatBit(a,DATEVAL)
#define TimeVal(a) StatBit(a,STIMEVAL)
#define TStampVal(a) StatBit(a,TSTMPVAL)
#define FreeUnlessNil(p) if((p)!=Nil) free(p)
#define CheckClose(f) if(f) {fclose(f); f=Nil;}
#define Space(s) (s == ' ' || s == '\n' || s == '\r' || s == '\t')
#define SkipComment while ( (c = InChar(f)) != '\n' && c != EOF )
#define rint(x) floor((x)+0.5) /* for consistency across platforms */
#define P1(x) (rint((x)*10) / 10)
#define No(f,l) ((l)-(f)+1)
#define SplitVal(g,i) ( Continuous(ClassAtt) ? (g) : (g) / ((i) + 1E-6) )
#define NOFILE 0
#define BADATTNAME 1
#define EOFINATT 2
#define SINGLEATTVAL 3
#define BADATTVAL 4
#define BADNUMBER 25
#define BADCLASS 5
#define DUPATTNAME 6
#define NOMEM 8
#define TOOMANYVALS 9
#define BADDISCRETE 10
#define UNKNOWNATT 11
#define LONGNAME 13
#define HITEOF 14
#define MISSNAME 15
#define BADDATE 16
#define BADTIME 17
#define BADDEF1 20
#define BADDEF2 21
#define BADDEF3 22
#define SAMEATT 23
#define BADTSTMP 24
#define BADSIFT 30
#define READDATA 1
#define READTEST 2
#define READCASES 3
#define PRELIM 4
#define CHECKING 5
#define REPORTING 6
#define CLEANUP 7
#define CONT_GT 1 /* CONT_GLT = CONT_GT | CONT_LT */
#define CONT_LT 2
#define CONT_GLT 3
#define CONT_NA 4
#define DISCR_GT 5 /* DISCR_GLT = DISCR_GT | DISCR_LT */
#define DISCR_LT 6
#define DISCR_GLT 7
#define DISCR_VAL 8
#define DISCR_SET 9
/*************************************************************************/
/* */
/* Type definitions */
/* */
/*************************************************************************/
typedef unsigned char Boolean, BranchType, *Set;
typedef char *String;
typedef int CaseNo, /* data item number */
CaseCount; /* count of items */
typedef int DiscrValue, /* discrete attribute value (0 = ?) */
Attribute; /* attribute number, 1..MaxAtt */
/* defining USEDOUBLE allows for DP
attribute values, but will not affect
use of saved analyses */
#ifdef USEDOUBLE
typedef double ContValue; /* continuous attribute value */
#define PREC 14 /* precision */
#define MARKER MAXDOUBLE
#else
typedef float ContValue; /* continuous attribute value */
#define PREC 7 /* precision */
#define MARKER MAXFLOAT
#endif
typedef union _def_val
{
String _s_val; /* att val for comparison */
ContValue _n_val; /* number for arith */
}
DefVal;
typedef struct _def_elt
{
short _op_code; /* type of element */
DefVal _operand; /* string or numeric value */
}
DefElt, *Definition;
typedef struct _elt_rec
{
int Fi, /* index of first char of element */
Li; /* last ditto */
char Type; /* 'B', 'S', or 'N' */
}
EltRec;
#define DefOp(DE) DE._op_code
#define DefSVal(DE) DE._operand._s_val
#define DefNVal(DE) DE._operand._n_val
#define OP_ATT 0 /* opcodes */
#define OP_NUM 1
#define OP_STR 2
#define OP_MISS 3
#define OP_AND 10
#define OP_OR 11
#define OP_EQ 20
#define OP_NE 21
#define OP_GT 22
#define OP_GE 23
#define OP_LT 24
#define OP_LE 25
#define OP_SEQ 26
#define OP_SNE 27
#define OP_PLUS 30
#define OP_MINUS 31
#define OP_UMINUS 32
#define OP_MULT 33
#define OP_DIV 34
#define OP_MOD 35
#define OP_POW 36
#define OP_SIN 40
#define OP_COS 41
#define OP_TAN 42
#define OP_LOG 43
#define OP_EXP 44
#define OP_INT 45
#define OP_END 99
typedef struct _testrec
{
Attribute Att; /* attribute tested */
DiscrValue Br; /* branch of test */
ContValue Cut; /* threshold (if relevant) */
Set Left; /* values for left br (if relevant) */
}
TestRec;
typedef struct _clustcondrec
{
int Type; /* type of test */
Attribute Att; /* attribute tested */
ContValue Low, /* low thresh or start of range */
High; /* high threshold or end of range */
Set Values; /* value subset if required */
}
ClustCond;
typedef struct _clustrec
{
Attribute Att; /* focus attribute */
ClustCond *Cond; /* group conditions */
int NCond; /* number of group conditions */
ContValue Expect, /* mean | (int) modal value */
SD, /* sd (trimmed) */
Limit; /* low / high value for normal cases */
float Frac; /* proportion of "normal" cases */
CaseCount GpSize; /* size of group */
}
ClustRec, *Clust;
typedef union _attribute_value
{
DiscrValue _discr_val;
ContValue _cont_val;
String _string_val;
Clust _clust;
}
AttValue, *Description;
typedef struct _sort_pair
{
ContValue C;
Description D;
}
SortPair;
typedef struct _caveat_rec
{
Attribute Att;
Set Subset;
float Low, High;
}
CaveatRec;
typedef struct _treerec *Tree;
typedef struct _treerec
{
BranchType NodeType; /* 0 | BrDiscr | BrThresh | BrSubset */
Attribute Tested; /* attribute referenced in test */
int Forks; /* number of branches at this node */
ContValue Cut; /* threshold for continuous attribute */
Set Left; /* subset of values for first branch */
Tree *Branch, /* Branch[x] = subtree for outcome x */
Parent; /* parent node */
DiscrValue Br; /* branch from parent */
String SiftEntry; /* text for sift file */
}
TreeRec;
typedef struct _env_rec
{
CaseCount **Freq,
**BestFreq,
*ValFreq,
*ClassFreq,
BrFreq[4];
Boolean *Left,
*Possible;
double *Gain,
*Info,
*ValSum,
*ValSumSq,
BrSum[4],
BrSumSq[4],
BaseInfo,
FRAC,
PSD;
Set *Subset;
ContValue *Bar;
int Level,
MaxLevel,
*Tested;
TestRec *Test;
String SiftEntry;
int SiftSize,
SiftSpace;
Attribute *DList; /* current discrete atts */
CaseCount ***DFreq; /* DFreq[a][][] = Freq[] for att a */
double **DValSum, /* ValSum[] for att a */
**DValSumSq; /* ValSumSq[] for att a */
}
EnvRec;
#define CVal(Case,Attribute) Case[Attribute]._cont_val
#define DVal(Case,Attribute) Case[Attribute]._discr_val
#define XDVal(Case,Att) (Case[Att]._discr_val & 077777777)
#define SVal(Case,Attribute) Case[Attribute]._string_val
#define CClass(Case) (*Case)._cont_val
#define DClass(Case) ((*Case)._discr_val & 077777777)
#define Unknown(Case,Att) (DVal(Case,Att)==UNKNOWN)
#define UnknownVal(AV) (AV._discr_val==UNKNOWN)
#define NotApplic(Case,Att) (DVal(Case,Att)==NA)
#define NotApplicVal(AV) (AV._discr_val==NA)
#define OutXVal(Case) Case[MaxAtt+1]._cont_val
#define OutClust(Case) Case[MaxAtt+2]._clust
#define ZScore(i) (fabs(CClass(Case[i])-Mean) / SD)
#define MaxAnoms(N) (MAXFRAC*(N)+2*sqrt((N)*MAXFRAC*(1-MAXFRAC))+1)
#define DScore(n,a,p) ((a) / ((double) (n)*(p)))
/* XDScore is a specialised version for possibly non-occuring vals */
#define XDScore(f,n,a,p) ((f) ? (a) / ((double) (n)*(p)) :\
(p) ? (1 / ((n)+2.0)) / (p) : (1 / ((n)+2.0)))
/*************************************************************************/
/* */
/* Function prototypes */
/* */
/*************************************************************************/
/* getnames.c */
Boolean ReadName(FILE *f, String s, int n, char ColonOpt);
void GetNames(FILE *Nf);
void ExplicitAtt(FILE *Nf);
int Which(String Val, String *List, int First, int Last);
String CopyString(String S);
void FreeNames(void);
int InChar(FILE *f);
/* implicitatt.c */
void ImplicitAtt(FILE *Nf);
void ReadDefinition(FILE *f);
void Append(char c);
Boolean Expression(void);
Boolean Conjunct(void);
Boolean SExpression(void);
Boolean AExpression(void);
Boolean Term(void);
Boolean Factor(void);
Boolean Primary(void);
Boolean Atom(void);
Boolean Find(String S);
int FindOne(String *Alt);
Attribute FindAttName(void);
void DefSyntaxError(String Msg);
void DefSemanticsError(int Fi, String Msg, int OpCode);
void Dump(char OpCode, ContValue F, String S, int Fi);
void DumpOp(char OpCode, int Fi);
Boolean UpdateTStack(char OpCode, ContValue F, String S, int Fi);
AttValue EvaluateDef(Definition D, Description Case);
/* getdata.c */
void GetData(FILE *Df, Boolean Train);
Description GetDescription(FILE *Df, Boolean Train);
void FreeData(void);
void FreeCase(Description DVec);
void CheckValue(Description DVec, Attribute Att);
/* check.c */
void CheckData(void);
void CheckContin(CaseNo Fp);
void FindContinOutliers(CaseNo Fp, CaseNo Lp, Boolean Sorted);
void LabelContinOutliers(Clust CL, Clust CH, CaseNo Fp, CaseNo GFp,
CaseNo GLp);
void TrimmedSDEstimate(CaseNo Fp, CaseNo Lp, double *Mean, double *SD);
CaseNo FindTail(CaseNo Fp, CaseNo Lp, int Inc, double Mean, double SD);
Boolean OmittedCases(int HiLo);
Boolean SatisfiesTests(Description Case);
void FindDiscrOutliers(CaseNo Fp, CaseNo Lp, CaseCount *Table);
CaseNo NoOtherDifference(CaseNo Fp, CaseNo Lp, CaseNo GFp, CaseNo GLp);
void InitialiseEnvData(void);
void FreeEnvData(void);
/* cluster.c */
Clust NewClust(ContValue Expect, ContValue SD, ContValue Limit,
CaseCount Anoms, CaseCount GpSize);
void SaveClustConds(Clust C);
void FormatContinCond(Attribute Att, ClustCond *CC);
void FormatOrderedCond(Attribute Att, ClustCond *CC);
void FormatSubsetCond(Attribute Att, ClustCond *CC);
void FormatValCond(Attribute Att, ClustCond *CC);
void FreeClust(Clust C);
/* outlier.c */
void RecordOutlier(CaseNo i, Clust C, float XVal);
void ReportOutliers(void);
void PrintAttVal(Description Case, Attribute Att);
void PrintOutlier(CaseNo i, Clust C, ContValue SVal);
void PrintContinCond(Attribute Att, ContValue Lo, ContValue Hi, CaseNo N);
void PrintOrderedCond(Attribute Att, DiscrValue Lo, DiscrValue Hi, CaseNo N);
void PrintSubsetCond(Attribute Att, Set Values, CaseNo N);
void PrintValCond(Attribute Att, DiscrValue v);
/* common.c */
void InitialiseDAC(void);
void FreeDAC(void);
void Split(CaseNo Fp, CaseNo Lp, int CondAtts, Tree Parent,
DiscrValue Br, Tree *Result);
void RecoverContext(Tree T, DiscrValue Br);
void DiscreteAttInfo(CaseNo Fp, CaseNo Lp, int CondAtts);
void ChooseSplitWithSampling(CaseNo Fp, CaseNo Lp, int CondAtts);
void Sample(CaseNo Fp, CaseNo Lp, CaseCount N);
void SampleScan(CaseNo Fp, CaseNo Lp, int CondAtts, Boolean Second);
void ChooseSplit(CaseNo Fp, CaseNo Lp, int CondAtts);
void FindBestAtt(Attribute *BestAtt, double *BestVal);
void CheckSplit(Attribute Att, CaseNo Fp, CaseNo Lp);
void Divide(Tree Node, CaseNo Fp, CaseNo Lp, int CondAtts);
void NoteTest(Attribute Att, DiscrValue Br, ContValue Cut, Set Left);
CaseNo SkipMissing(Attribute Att, CaseNo Fp, CaseNo Lp);
CaseNo Group(Attribute Att, DiscrValue V, CaseNo Fp, CaseNo Lp,
ContValue Cut, Set Left);
void CheckPotentialClusters(Attribute Att, DiscrValue Forks,
CaseNo Fp, CaseNo Lp, ContValue B, Set S,
CaseCount **FT);
void ShowContext(CaseNo i);
Tree Leaf(Tree Parent, DiscrValue Br);
void ReleaseTree(Tree T, int Level);
void OutputConditions(void);
/* continatt.c */
void CEvalContinAtt(Attribute Att, CaseNo Fp, CaseNo Lp);
ContValue Between(ContValue Low, ContValue High);
void CEvalDiscrAtt(Attribute Att, CaseNo Fp, CaseNo Lp);
void EvalBinarySplit(Attribute Att, CaseNo Fp, CaseNo Lp);
void EvalSubsetSplit(Attribute Att, CaseNo Fp, CaseNo Lp);
double SDEstimate(CaseCount N, double Sum, double SumSq);
double ContinGain(void);
/* discratt.c */
void DEvalContinAtt(Attribute Att, CaseNo Fp, CaseNo Lp);
void DEvalDiscrAtt(Attribute Att, CaseNo Fp, CaseNo Lp);
void DEvalOrderedAtt(Attribute Att, CaseNo Fp, CaseNo Lp);
void ComputeFrequencies(Attribute Att, CaseNo Fp, CaseNo Lp);
void FindClassFrequencies(CaseNo Fp, CaseNo Lp);
double DiscrGain(DiscrValue MaxVal, CaseCount TotalCases);
double TotalInfo(CaseCount V[], DiscrValue MinVal, DiscrValue MaxVal);
/* sort.c */
void Quicksort(CaseNo Fp, CaseNo Lp, Attribute Att);
void Cachesort(CaseNo Fp, CaseNo Lp);
/* modelfiles.c */
void CheckFile(String Extension, Boolean Write);
void WriteFilePrefix(String Extension);
void SaveCondition(void);
void SaveDiscrCluster(DiscrValue Expect, CaseCount Anoms,
CaseCount Cases, CaseCount *Freq);
void SaveContinCluster(float Mean, float SD, CaseCount Cases,
float LFrac, float LLim, float HFrac, float HLim);
void SaveNames(void);
void AsciiOut(String Pre, String S);
void ReadFilePrefix(String Extension);
int ReadProp(char *Delim);
String RemoveQuotes(String S);
void ExtendSiftEntry(String S);
void ProcessSift(void);
void Case1(void);
void Case2(void);
void Case3(void);
void Case11(void);
void Case12(void);
void Case13(void);
void Case21(void);
void Case22(void);
void ReadCaveats(void);
Boolean CheckCaveats(Description Case);
void FoundPossibleAnom(CaseNo i, Clust C, float Xv);
void Filter(Attribute Att, DiscrValue Br, ContValue Cut, Set Left);
void SetTestedAtts(void);
/* utility.c */
void PrintHeader(String Title);
char ProcessOption(int Argc, char **Argv, char *Str);
void *Pmalloc(size_t Bytes);
void *Prealloc(void *Present, size_t Bytes);
void *Pcalloc(size_t Number, unsigned int Size);
void FreeVector(void **V, int First, int Last);
Description NewCase(void);
void MemTrim(void);
void FreeCases(void);
void FreeLastCase(Description Case);
double KRandom(void);
void ResetKR(int KRInit);
void Error(int ErrNo, String S1, String S2);
String CaseLabel(CaseNo N);
FILE * GetFile(String Extension, String RW);
double ExecTime(void);
int Denominator(ContValue Val);
int FracBase(Attribute Att);
int GetInt(String S, int N);
int DateToDay(String DS);
void DayToDate(int DI, String Date);
int TimeToSecs(String TS);
void SecsToTime(int Secs, String Time);
void SetTSBase(int y);
int TStampToMins(String TS);
void CValToStr(ContValue CV, Attribute Att, String DS);
void CleanupSift(void);
void Cleanup(void);
void Check(float Val, float Low, float High);
/* update.c */
void NotifyStage(int);
void Progress(int);
discratt.c 0000664 0000764 0000764 00000025536 11501534524 012764 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Divide-and-Conquer for discrete attributes */
/* ------------------------------------------ */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
/*************************************************************************/
/* */
/* Known values of continuous attributes are divided into */
/* three groups: */
/* (1) N/A */
/* (2) values less than a threshold */
/* (3) values greater than a threshold */
/* This routine finds the best threshold for items Fp through Lp */
/* and sets Gain[], Info[] and Bar[] */
/* */
/*************************************************************************/
void DEvalContinAtt(Attribute Att, CaseNo Fp, CaseNo Lp)
/* -------------- */
{
CaseNo i, BestI, Xp;
CaseCount Cases;
DiscrValue v, c;
double BestGain=-1E-6, BestInfo, ThisGain;
/* Reset frequencies */
ForEach(v, 0, 3)
{
ForEach(c, 1, MaxAttVal[ClassAtt])
{
GEnv.Freq[v][c] = 0;
}
GEnv.ValFreq[v] = 0;
}
/* Omit and count N/A values */
Xp = Fp;
ForEach(i, Fp, Lp)
{
if ( NotApplic(Case[i],Att) )
{
GEnv.Freq[1][DClass(Case[i])]++;
Swap(Xp, i);
Xp++;
}
else
{
GEnv.Freq[3][DClass(Case[i])]++;
}
}
/* Special case when very few known values */
if ( No(Xp, Lp) < 2 * (DMINITEMS*GEnv.FRAC) )
{
Verbosity(2,
fprintf(Of, "\tAtt %s: insufficient cases with known values\n",
AttName[Att]))
return;
}
Cases = No(Fp, Lp);
GEnv.ValFreq[0] = GEnv.ValFreq[1] = 0;
ForEach(c, 1, MaxAttVal[ClassAtt])
{
GEnv.ValFreq[1] += GEnv.Freq[1][c];
}
/* Sort all applicable values */
Quicksort(Xp, Lp, Att);
/* Try possible cuts between items i and i+1, and determine the
information and gain of the split in each case */
if ( Xp + (DMINITEMS*GEnv.FRAC) - 2 >= Lp ) return;
ForEach(i, Xp, Xp + (DMINITEMS*GEnv.FRAC) - 2)
{
c = DClass(Case[i]);
GEnv.Freq[2][c]++;
GEnv.Freq[3][c]--;
}
ForEach(i, Xp + (DMINITEMS*GEnv.FRAC) - 1, Lp - (DMINITEMS*GEnv.FRAC))
{
c = DClass(Case[i]);
GEnv.Freq[2][c]++;
GEnv.Freq[3][c]--;
if ( CVal(Case[i+1], Att) > CVal(Case[i], Att) )
{
GEnv.ValFreq[2] = i - Xp + 1;
GEnv.ValFreq[3] = Lp - i;
ThisGain = DiscrGain(3, Cases);
if ( ThisGain > BestGain + Epsilon )
{
BestGain = ThisGain;
BestInfo = TotalInfo(GEnv.ValFreq, 1, 3) / Cases;
BestI = i;
ForEach(v, 1, 3)
{
ForEach(c, 1, MaxAttVal[ClassAtt])
{
GEnv.BestFreq[v][c] = GEnv.Freq[v][c];
}
}
}
}
}
/* If a test on the attribute is able to make a gain,
set the best break point, gain and information */
if ( BestGain > Epsilon )
{
GEnv.Gain[Att] = BestGain;
GEnv.Info[Att] = BestInfo;
GEnv.Bar[Att] = Between(CVal(Case[BestI],Att), CVal(Case[BestI+1],Att));
Verbosity(2,
fprintf(Of, "\tAtt %s: cut=%.3f, inf %.3f, gain %.3f\n",
AttName[Att], GEnv.Bar[Att], GEnv.Info[Att], GEnv.Gain[Att]))
/* If not sampling, check subsets */
if ( GEnv.FRAC >= 1 )
{
if ( Xp > Fp )
{
NoteTest(Att, 1, 0.0, Nil);
FindDiscrOutliers(Fp, Xp-1, GEnv.BestFreq[1]);
}
NoteTest(Att, 2, GEnv.Bar[Att], Nil);
FindDiscrOutliers(Xp, BestI, GEnv.BestFreq[2]);
NoteTest(Att, 3, GEnv.Bar[Att], Nil);
FindDiscrOutliers(BestI+1, Lp, GEnv.BestFreq[3]);
}
}
else
{
Verbosity(2, fprintf(Of, "\tAtt %s: no gain\n", AttName[Att]))
}
}
/*************************************************************************/
/* */
/* Set Info[] and Gain[] for discrete partition of items Fp to Lp */
/* */
/*************************************************************************/
void DEvalDiscrAtt(Attribute Att, CaseNo Fp, CaseNo Lp)
/* ------------- */
{
CaseCount KnownCases;
int ReasonableSubsets=0;
DiscrValue v;
ComputeFrequencies(Att, Fp, Lp);
KnownCases = No(Fp, Lp);
/* Check reasonable subsets */
ForEach(v, 1, MaxAttVal[Att])
{
if ( GEnv.ValFreq[v] >= (DMINITEMS*GEnv.FRAC) ) ReasonableSubsets++;
}
if ( ReasonableSubsets < 2 )
{
Verbosity(2, fprintf(Of, "\tAtt %s: poor split\n", AttName[Att]))
return;
}
GEnv.Gain[Att] = DiscrGain(MaxAttVal[Att], KnownCases);
GEnv.Info[Att] = TotalInfo(GEnv.ValFreq, 1, MaxAttVal[Att]) / KnownCases;
if ( GEnv.Gain[Att] > Epsilon )
{
Verbosity(2,
fprintf(Of, "\tAtt %s: inf %.3f, gain %.3f\n",
AttName[Att], GEnv.Info[Att], GEnv.Gain[Att]))
}
else
{
GEnv.Gain[Att] = None;
Verbosity(2,
fprintf(Of, "\tAtt %s: no gain\n", AttName[Att]))
}
if ( GEnv.FRAC >= 1 && GEnv.Gain[Att] > Epsilon )
{
CheckPotentialClusters(Att, MaxAttVal[Att], Fp, Lp, 0.0, Nil, GEnv.Freq);
}
}
/*************************************************************************/
/* */
/* Set Info[] and Gain[] for ordered split on items Fp to Lp */
/* */
/*************************************************************************/
void DEvalOrderedAtt(Attribute Att, CaseNo Fp, CaseNo Lp)
/* --------------- */
{
CaseCount KnownCases, *HoldFreqRow, SplitFreq[4];
DiscrValue v, BestV, vv, c;
double ThisGain, BestInfo, BestGain=-1E-6;
ComputeFrequencies(Att, Fp, Lp);
KnownCases = No(Fp, Lp);
/* Move elts of Freq[] starting with the third up one place
and aggregate class frequencies */
HoldFreqRow = GEnv.Freq[MaxAttVal[Att]+1];
ForEach(c, 1, MaxAttVal[ClassAtt])
{
HoldFreqRow[c] = 0;
}
SplitFreq[0] = GEnv.ValFreq[0];
SplitFreq[1] = GEnv.ValFreq[1];
SplitFreq[2] = GEnv.ValFreq[2];
SplitFreq[3] = 0;
for ( v = MaxAttVal[Att] ; v > 2 ; v-- )
{
GEnv.Freq[v+1] = GEnv.Freq[v];
ForEach(c, 1, MaxAttVal[ClassAtt])
{
HoldFreqRow[c] += GEnv.Freq[v][c];
}
SplitFreq[3] += GEnv.ValFreq[v];
}
GEnv.Freq[3] = HoldFreqRow;
/* Try various cuts, saving the one with maximum gain */
ForEach(v, 3, MaxAttVal[Att])
{
if ( SplitFreq[2] >= (DMINITEMS*GEnv.FRAC) &&
SplitFreq[3] >= (DMINITEMS*GEnv.FRAC) )
{
ThisGain = DiscrGain(3, KnownCases);
if ( ThisGain > BestGain + Epsilon )
{
BestGain = ThisGain;
BestInfo = TotalInfo(SplitFreq, 0, 3) / KnownCases;
BestV = v-1;
ForEach(vv, 1, 3)
{
ForEach(c, 1, MaxAttVal[ClassAtt])
{
GEnv.BestFreq[vv][c] = GEnv.Freq[vv][c];
}
}
}
}
/* Move val v from right branch to left branch */
ForEach(c, 1, MaxAttVal[ClassAtt])
{
GEnv.Freq[2][c] += GEnv.Freq[v+1][c];
GEnv.Freq[3][c] -= GEnv.Freq[v+1][c];
}
SplitFreq[2] += GEnv.ValFreq[v];
SplitFreq[3] -= GEnv.ValFreq[v];
}
/* If a test on the attribute is able to make a gain,
set the best break point, gain and information */
if ( BestGain > Epsilon )
{
GEnv.Gain[Att] = BestGain;
GEnv.Info[Att] = BestInfo;
GEnv.Bar[Att] = BestV + 0.1;
ClearBits((MaxAttVal[Att]>>3)+1, GEnv.Subset[Att]);
ForEach(v, 2, BestV)
{
SetBit(v, GEnv.Subset[Att]);
}
Verbosity(2,
fprintf(Of, "\tAtt %s: cut after %s, inf %.3f, gain %.3f\n",
AttName[Att], AttValName[Att][(int) GEnv.Bar[Att]],
GEnv.Info[Att], GEnv.Gain[Att]))
if ( GEnv.FRAC >= 1 )
{
CheckPotentialClusters(Att, 3, Fp, Lp, GEnv.Bar[Att], GEnv.Subset[Att],
GEnv.BestFreq);
}
}
else
{
Verbosity(2, fprintf(Of, "\tAtt %s: no gain\n", AttName[Att]))
}
}
/*************************************************************************/
/* */
/* Compute frequency tables Freq[][] and ValFreq[] for attribute */
/* Att from items Fp to Lp */
/* */
/*************************************************************************/
void ComputeFrequencies(Attribute Att, CaseNo Fp, CaseNo Lp)
/* ------------------ */
{
DiscrValue v, c;
CaseNo Sum;
ForEach(v, 0, MaxAttVal[Att])
{
Sum = 0;
ForEach(c, 1, MaxAttVal[ClassAtt])
{
Sum += (GEnv.Freq[v][c] = GEnv.DFreq[Att][v][c]);
}
GEnv.ValFreq[v] = Sum;
}
}
void FindClassFrequencies(CaseNo Fp, CaseNo Lp)
/* -------------------- */
{
DiscrValue v;
CaseNo i;
ForEach(v, 1, MaxAttVal[ClassAtt])
{
GEnv.ClassFreq[v] = 0;
}
ForEach(i, Fp, Lp)
{
GEnv.ClassFreq[DClass(Case[i])]++;
}
}
/*************************************************************************/
/* */
/* Given Freq[][] and ValFreq[], compute the information gain */
/* */
/*************************************************************************/
double DiscrGain(DiscrValue MaxVal, CaseCount KnownCases)
/* --------- */
{
DiscrValue v;
double ThisInfo=0.0;
/* Check whether all values are unknown or the same */
if ( ! KnownCases ) return None;
/* Compute total info after split, by summing the
info of each of the subsets formed by the test */
ForEach(v, 1, MaxVal)
{
ThisInfo += TotalInfo(GEnv.Freq[v], 1, MaxAttVal[ClassAtt]);
}
/* Set the gain in information for all items */
return GEnv.BaseInfo - ThisInfo / KnownCases;
}
/*************************************************************************/
/* */
/* Compute the total information in V[ MinVal..MaxVal ]. */
/* Use tabulate logs of numbers of cases */
/* */
/*************************************************************************/
double TotalInfo(CaseCount V[], DiscrValue MinVal, DiscrValue MaxVal)
/* --------- */
{
DiscrValue v;
double Sum=0.0;
CaseCount N, TotalCases=0;
ForEach(v, MinVal, MaxVal)
{
N = V[v];
Sum += N * LogCaseNo[N];
TotalCases += N;
}
return TotalCases * LogCaseNo[TotalCases] - Sum;
}
extern.i 0000664 0000764 0000764 00000004471 11501534524 012455 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* External references to data in global.c */
/* --------------------------------------- */
/* */
/*************************************************************************/
extern Attribute ClassAtt,
LabelAtt;
extern int MaxAtt,
MaxDiscrVal,
MaxLabel,
LineNo,
ErrMsgs,
AttExIn,
TSBase;
extern CaseNo MaxCase,
LastDataCase;
extern Description *Case,
*SaveCase;
extern DiscrValue *MaxAttVal;
extern char *SpecialStatus;
extern Definition *AttDef;
extern String *AttName,
**AttValName;
extern int VERBOSITY,
MAXCONDATTS,
MAXOUT;
extern Boolean SIFT,
LIST,
TargetSaved;
extern CaseCount CMINITEMS,
DMINITEMS,
SampleSize;
extern float MINABNORM,
CF;
extern double **Prior,
*LogCaseNo,
*Rand;
extern unsigned char *Prec;
extern int LastLevel;
extern char Fn[500];
extern Boolean *UseLogs,
*SomeMiss,
*SomeNA;
extern ContValue *LowTail,
*HighTail;
extern Clust *Cluster;
extern int NClust,
ClustSpace;
extern EnvRec GEnv;
extern FILE *Sf;
extern Tree T;
extern String FileStem;
getdata.c 0000664 0000764 0000764 00000016126 11501534524 012553 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Get case descriptions from data file */
/* -------------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
#define Inc 2048
/*************************************************************************/
/* */
/* Read raw case descriptions from file with given extension. */
/* */
/* On completion, cases are stored in array Case in the form */
/* of descriptions (i.e. arrays of attribute values), and */
/* MaxCase is set to the number of data items. */
/* */
/*************************************************************************/
void GetData(FILE *Df, Boolean Train)
/* ------- */
{
Description DVec;
CaseNo CaseSpace;
LineNo = 0;
if ( Train )
{
MaxCase = MaxLabel = 0;
CaseSpace = 100;
Case = Alloc(CaseSpace+1, Description); /* for error reporting */
}
else
{
MaxCase++;
CaseSpace = MaxCase;
}
while ( (DVec = GetDescription(Df, Train)) )
{
/* Make sure there is room for another item */
if ( MaxCase >= CaseSpace )
{
CaseSpace += Inc;
Realloc(Case, CaseSpace+1, Description);
}
Case[MaxCase] = DVec;
MaxCase++;
}
fclose(Df);
MaxCase--;
}
/*************************************************************************/
/* */
/* Read a raw case description from file Df. */
/* */
/* For each attribute, read the attribute value from the file. */
/* If it is a discrete valued attribute, find the associated no. */
/* of this attribute value (if the value is unknown this is 0). */
/* */
/* Returns the description of the case (i.e. a pointer to the array */
/* of attribute values). */
/* */
/*************************************************************************/
Description GetDescription(FILE *Df, Boolean Train)
/* -------------- */
{
Attribute Att;
char name[1000], *endname;
int Dv, Chars;
ContValue Cv;
Description DVec;
Boolean FirstValue=true;
if ( ReadName(Df, name, 1000, '\00') )
{
Case[MaxCase] = DVec = NewCase();
OutXVal(DVec) = 1.0;
OutClust(DVec) = Nil;
ForEach(Att, 1, MaxAtt)
{
if ( AttDef[Att] )
{
DVec[Att] = EvaluateDef(AttDef[Att], DVec);
if ( Continuous(Att) )
{
CheckValue(DVec, Att);
}
continue;
}
/* Get the attribute value if don't already have it */
if ( ! FirstValue && ! ReadName(Df, name, 1000, '\00') )
{
Error(HITEOF, AttName[Att], "");
FreeLastCase(DVec);
return Nil;
}
FirstValue = false;
if ( Exclude(Att) )
{
if ( Att == LabelAtt )
{
/* Record the value as a string */
SVal(DVec,Att) = Alloc(strlen(name)+1, char);
strcpy(SVal(DVec,Att), name);
}
}
else
if ( ! ( strcmp(name, "?") ) )
{
/* Set marker to indicate missing value */
DVal(DVec, Att) = UNKNOWN;
}
else
if ( ! strcmp(name, "N/A") )
{
/* Set marker to indicate not applicable */
DVal(DVec, Att) = NA;
}
else
if ( Discrete(Att) )
{
Dv = Which(name, AttValName[Att], 1, MaxAttVal[Att]);
if ( ! Dv )
{
if ( StatBit(Att, DISCRETE) )
{
if ( ! strcmp("cases", Fn + strlen(Fn) - 5) )
{
/* This is a gritcheck */
Dv = UNKNOWN;
}
else
{
/* Add value to list */
if ( MaxAttVal[Att] >= (long) AttValName[Att][0] )
{
Error(TOOMANYVALS, AttName[Att],
(char *) AttValName[Att][0] - 1);
Dv = MaxAttVal[Att];
}
else
{
Dv = ++MaxAttVal[Att];
AttValName[Att][Dv] = strdup(name);
AttValName[Att][Dv+1] = ""; /* no free */
}
if ( Dv > MaxDiscrVal )
{
MaxDiscrVal = Dv;
}
}
}
else
{
Error(BADATTVAL, AttName[Att], name);
}
}
DVal(DVec, Att) = Dv;
}
else
{
/* Continuous value */
if ( TStampVal(Att) )
{
CVal(DVec, Att) = Cv = TStampToMins(name);
if ( Cv >= 1E9 ) /* long time in future */
{
Error(BADTSTMP, AttName[Att], name);
DVal(DVec, Att) = UNKNOWN;
}
}
else
if ( DateVal(Att) )
{
CVal(DVec, Att) = Cv = DateToDay(name);
if ( Cv < 1 )
{
Error(BADDATE, AttName[Att], name);
DVal(DVec, Att) = UNKNOWN;
}
}
else
if ( TimeVal(Att) )
{
CVal(DVec, Att) = Cv = TimeToSecs(name);
if ( Cv < 0 )
{
Error(BADTIME, AttName[Att], name);
DVal(DVec, Att) = UNKNOWN;
}
}
else
{
CVal(DVec, Att) = strtod(name, &endname);
if ( endname == name || *endname != '\0' )
{
Error(BADATTVAL, AttName[Att], name);
DVal(DVec, Att) = UNKNOWN;
}
}
CheckValue(DVec, Att);
}
}
if ( LabelAtt && (Chars = strlen(SVal(DVec, LabelAtt))) > MaxLabel )
{
MaxLabel = Chars;
}
return DVec;
}
else
{
return Nil;
}
}
/*************************************************************************/
/* */
/* Free case description space */
/* */
/*************************************************************************/
void FreeData()
/* -------- */
{
CaseNo i;
/* Release any strings holding case labels */
if ( LabelAtt )
{
ForEach(i, 0, MaxCase)
{
FreeUnlessNil(SVal(Case[i],LabelAtt));
}
}
FreeCases();
Free(Case); Case = Nil;
MaxCase = -1;
}
/*************************************************************************/
/* */
/* Check for bad continuous value */
/* */
/*************************************************************************/
void CheckValue(Description DVec, Attribute Att)
/* ---------- */
{
ContValue Cv;
Cv = CVal(DVec, Att);
if ( ! finite(Cv) )
{
Error(BADNUMBER, AttName[Att], "");
CVal(DVec, Att) = UNKNOWN;
DVal(DVec, Att) = 0;
}
}
getnames.c 0000664 0000764 0000764 00000030412 11501534524 012737 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Get names of classes, attributes and attribute values */
/* ----------------------------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
#include
#include
#define MAXLINEBUFFER 10000
int Delimiter;
char LineBuffer[MAXLINEBUFFER], *LBp=LineBuffer;
/*************************************************************************/
/* */
/* Read a name from file f into string s, setting Delimiter. */
/* */
/* - Embedded periods are permitted, but periods followed by space */
/* characters act as delimiters. */
/* - Embedded spaces are permitted, but multiple spaces are */
/* replaced by a single space. */
/* - Any character can be escaped by '\'. */
/* - The remainder of a line following '|' is ignored. */
/* */
/* Colons are sometimes delimiters depending on ColonOpt */
/* */
/*************************************************************************/
Boolean ReadName(FILE *f, String s, int n, char ColonOpt)
/* -------- */
{
register char *Sp=s;
register int c;
char Msg[2];
/* Skip to first non-space character */
while ( (c = InChar(f)) == '|' || Space(c) )
{
if ( c == '|' ) SkipComment;
}
/* Return false if no names to read */
if ( c == EOF )
{
Delimiter = EOF;
return false;
}
/* Read in characters up to the next delimiter */
while ( c != ColonOpt && c != ',' && c != '\n' && c != '|' && c != EOF )
{
if ( --n <= 0 )
{
if ( Of ) Error(LONGNAME, "", "");
}
if ( c == '.' )
{
if ( (c = InChar(f)) == '|' || Space(c) || c == EOF ) break;
*Sp++ = '.';
continue;
}
if ( c == '\\' )
{
c = InChar(f);
}
if ( Space(c) )
{
*Sp++ = ' ';
while ( ( c = InChar(f) ) == ' ' || c == '\t' )
;
}
else
{
*Sp++ = c;
c = InChar(f);
}
}
if ( c == '|' ) SkipComment;
Delimiter = c;
/* Special case for ':=' */
if ( Delimiter == ':' )
{
if ( *LBp == '=' )
{
Delimiter = '=';
LBp++;
}
}
/* Strip trailing spaces */
while ( Sp > s && Space(*(Sp-1)) ) Sp--;
if ( Sp == s )
{
Msg[0] = ( Space(c) ? '.' : c );
Msg[1] = '\00';
Error(MISSNAME, Fn, Msg);
}
*Sp++ = '\0';
return true;
}
#ifndef INSPECT
/*************************************************************************/
/* */
/* Read names of classes, attributes and legal attribute values. */
/* On completion, names are stored in: */
/* AttName - attribute names */
/* AttValName - attribute value names */
/* with: */
/* MaxAttVal - number of values for each attribute */
/* */
/* Other global variables set are: */
/* MaxAtt - maximum attribute number */
/* MaxDiscrVal - maximum discrete values for an attribute */
/* */
/*************************************************************************/
void GetNames(FILE *Nf)
/* -------- */
{
char Buffer[1000]="";
int AttCeiling=100, ClassCeiling=100;
DiscrValue MaxClass=0, v;
String *ExplicitClass;
Attribute Att;
ErrMsgs = AttExIn = 0;
LineNo = 0;
/* Get class names from names file */
ExplicitClass = AllocZero(ClassCeiling, String);
ClassAtt = LabelAtt = 0;
do
{
ReadName(Nf, Buffer, 1000, ':');
if ( ++MaxClass >= ClassCeiling)
{
ClassCeiling += 100;
Realloc(ExplicitClass, ClassCeiling, String);
}
ExplicitClass[MaxClass] = strdup(Buffer);
}
while ( Delimiter == ',' );
/* Ignore thresholds for See5/C5.0 continuous class attribute */
if ( Delimiter == ':' )
{
do
{
ReadName(Nf, Buffer, 1000, ':');
}
while ( Delimiter == ',' );
}
/* Get attribute and attribute value names from names file */
AttName = AllocZero(AttCeiling, String);
MaxAttVal = AllocZero(AttCeiling, DiscrValue);
AttValName = AllocZero(AttCeiling, String *);
SpecialStatus = AllocZero(AttCeiling, char);
AttDef = AllocZero(AttCeiling, Definition);
MaxAtt = 0;
while ( ReadName(Nf, Buffer, 1000, ':') )
{
if ( Delimiter != ':' && Delimiter != '=' )
{
Error(BADATTNAME, Buffer, "");
}
/* Check for include/exclude instruction */
if ( ( *Buffer == 'a' || *Buffer == 'A' ) &&
! memcmp(Buffer+1, "ttributes ", 10) &&
! memcmp(Buffer+strlen(Buffer)-6, "cluded", 6) )
{
AttExIn = ( ! memcmp(Buffer+strlen(Buffer)-8, "in", 2) ? 1 : -1 );
if ( AttExIn == 1 )
{
ForEach(Att, 1, MaxAtt)
{
SpecialStatus[Att] |= SKIP;
}
}
while ( ReadName(Nf, Buffer, 1000, ':') )
{
Att = Which(Buffer, AttName, 1, MaxAtt);
if ( ! Att )
{
Error(UNKNOWNATT, Buffer, Nil);
}
else
if ( AttExIn == 1 )
{
SpecialStatus[Att] -= SKIP;
}
else
{
SpecialStatus[Att] |= SKIP;
}
}
break;
}
if ( Which(Buffer, AttName, 1, MaxAtt) > 0 )
{
Error(DUPATTNAME, Buffer, Nil);
}
if ( ++MaxAtt >= AttCeiling-1 ) /* ensure space for class att */
{
AttCeiling += 100;
Realloc(AttName, AttCeiling, String);
Realloc(MaxAttVal, AttCeiling, DiscrValue);
Realloc(AttValName, AttCeiling, String *);
Realloc(SpecialStatus, AttCeiling, char);
Realloc(AttDef, AttCeiling, Definition);
}
AttName[MaxAtt] = strdup(Buffer);
SpecialStatus[MaxAtt] = Nil;
AttDef[MaxAtt] = Nil;
MaxAttVal[MaxAtt] = 0;
if ( Delimiter == '=' )
{
if ( MaxClass == 1 && ! strcmp(ExplicitClass[1], AttName[MaxAtt]) )
{
Error(BADDEF3, Nil, Nil);
}
ImplicitAtt(Nf);
}
else
{
ExplicitAtt(Nf);
}
}
/* Check whether class is one of the attributes */
if ( MaxClass == 1 )
{
ClassAtt = Which(ExplicitClass[1], AttName, 1, MaxAtt);
Free(ExplicitClass[1]);
Free(ExplicitClass);
}
else
{
MaxAtt++;
AttName[MaxAtt] = strdup("class");
/* Set up last attribute with values "N/A" and explicit classes */
AttValName[MaxAtt] = Alloc(MaxClass+2, String);
AttValName[MaxAtt][1] = strdup("N/A");
ForEach(v, 1, MaxClass)
{
AttValName[MaxAtt][v+1] = ExplicitClass[v];
}
Free(ExplicitClass);
MaxAttVal[MaxAtt] = MaxClass+1;
MaxDiscrVal = Max(MaxDiscrVal, MaxClass+1);
AttDef[MaxAtt] = Nil;
SpecialStatus[MaxAtt] = ( AttExIn == 1 ? SKIP : 0 );
}
fclose(Nf);
if ( ErrMsgs > 0 ) Goodbye(1);
}
/*************************************************************************/
/* */
/* Continuous or discrete attribute */
/* */
/*************************************************************************/
void ExplicitAtt(FILE *Nf)
/* ----------- */
{
char Buffer[1000]="", *p;
DiscrValue v;
int ValCeiling=100, BaseYear;
time_t clock;
/* Read attribute type or first discrete value */
if ( ! ( ReadName(Nf, Buffer, 1000, ':') ) )
{
Error(EOFINATT, AttName[MaxAtt], "");
}
MaxAttVal[MaxAtt] = 0;
if ( Delimiter != ',' )
{
/* Typed attribute */
if ( ! strcmp(Buffer, "continuous") )
{
}
else
if ( ! strcmp(Buffer, "timestamp") )
{
SpecialStatus[MaxAtt] = TSTMPVAL;
/* Set the base date if not done already */
if ( ! TSBase )
{
clock = time(0);
BaseYear = gmtime(&clock)->tm_year + 1900;
SetTSBase(BaseYear);
}
}
else
if ( ! strcmp(Buffer, "date") )
{
SpecialStatus[MaxAtt] = DATEVAL;
}
else
if ( ! strcmp(Buffer, "time") )
{
SpecialStatus[MaxAtt] = STIMEVAL;
}
else
if ( ! memcmp(Buffer, "discrete", 8) )
{
SpecialStatus[MaxAtt] = DISCRETE;
/* Read max values and reserve space */
v = atoi(&Buffer[8]);
if ( v < 2 )
{
Error(BADDISCRETE, AttName[MaxAtt], "");
}
AttValName[MaxAtt] = Alloc(v+3, String);
AttValName[MaxAtt][0] = (char *) (long) v+1;
AttValName[MaxAtt][(MaxAttVal[MaxAtt]=1)] = strdup("N/A");
}
else
if ( ! strcmp(Buffer, "ignore") )
{
SpecialStatus[MaxAtt] = EXCLUDE;
}
else
if ( ! strcmp(Buffer, "label") )
{
LabelAtt = MaxAtt;
SpecialStatus[MaxAtt] = EXCLUDE;
}
else
{
/* Cannot have only one discrete value for an attribute */
Error(SINGLEATTVAL, AttName[MaxAtt], Buffer);
}
}
else
{
/* Discrete attribute with explicit values */
AttValName[MaxAtt] = AllocZero(ValCeiling, String);
/* Add "N/A" */
AttValName[MaxAtt][(MaxAttVal[MaxAtt]=1)] = strdup("N/A");
p = Buffer;
/* Special check for ordered attribute */
if ( ! memcmp(Buffer, "[ordered]", 9) )
{
SpecialStatus[MaxAtt] = ORDERED;
for ( p = Buffer+9 ; Space(*p) ; p++ )
;
}
/* Record first real explicit value */
AttValName[MaxAtt][++MaxAttVal[MaxAtt]] = strdup(p);
/* Record remaining values */
do
{
if ( ! ( ReadName(Nf, Buffer, 1000, ':') ) )
{
Error(EOFINATT, AttName[MaxAtt], "");
}
if ( ++MaxAttVal[MaxAtt] >= ValCeiling )
{
ValCeiling += 100;
Realloc(AttValName[MaxAtt], ValCeiling, String);
}
AttValName[MaxAtt][MaxAttVal[MaxAtt]] = strdup(Buffer);
}
while ( Delimiter == ',' );
/* Cancel ordered status if <3 real values */
if ( Ordered(MaxAtt) && MaxAttVal[MaxAtt] <= 3 )
{
SpecialStatus[MaxAtt] = 0;
}
if ( MaxAttVal[MaxAtt] > MaxDiscrVal ) MaxDiscrVal = MaxAttVal[MaxAtt];
}
}
#endif
/*************************************************************************/
/* */
/* Locate value Val in List[First] to List[Last] */
/* */
/*************************************************************************/
int Which(String Val, String *List, int First, int Last)
/* ----- */
{
int n=First;
while ( n <= Last && strcmp(Val, List[n]) ) n++;
return ( n <= Last ? n : First-1 );
}
/*************************************************************************/
/* */
/* Free up all space allocated by GetNames() */
/* */
/*************************************************************************/
void FreeNames()
/* --------- */
{
Attribute a, t;
ForEach(a, 1, MaxAtt)
{
if ( Discrete(a) )
{
FreeVector((void **) AttValName[a], 1, MaxAttVal[a]);
}
}
FreeUnlessNil(AttValName); AttValName = Nil;
FreeUnlessNil(MaxAttVal); MaxAttVal = Nil;
FreeVector((void **) AttName, 1, MaxAtt); AttName = Nil;
FreeUnlessNil(SpecialStatus); SpecialStatus = Nil;
/* Definitions (if any) */
if ( AttDef )
{
ForEach(a, 1, MaxAtt)
{
if ( AttDef[a] )
{
for ( t = 0 ; DefOp(AttDef[a][t]) != OP_END ; t++ )
{
if ( DefOp(AttDef[a][t]) == OP_STR )
{
Free(DefSVal(AttDef[a][t]));
}
}
Free(AttDef[a]);
}
}
Free(AttDef); AttDef = Nil;
}
}
/*************************************************************************/
/* */
/* Read next char keeping track of line numbers */
/* */
/*************************************************************************/
int InChar(FILE *f)
/* ------ */
{
if ( ! *LBp )
{
LBp = LineBuffer;
if ( ! fgets(LineBuffer, MAXLINEBUFFER, f) )
{
LineBuffer[0] = '\00';
return EOF;
}
LineNo++;
}
return (int) *LBp++;
}
global.c 0000664 0000764 0000764 00000006533 11501534524 012403 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Global Data */
/* ----------- */
/* */
/*************************************************************************/
#include "defns.i"
Attribute ClassAtt=0, /* attribute to use as class */
LabelAtt; /* attribute to use as case ID */
int MaxAtt, /* max att number */
MaxDiscrVal=3, /* max discrete values for any att */
MaxLabel=0, /* max characters in case label */
LineNo=0, /* input line number */
ErrMsgs=0, /* errors found */
AttExIn, /* attribute exclusions/inclusions */
TSBase=0; /* base day for time stamps */
CaseNo MaxCase=-1, /* max data item number */
LastDataCase; /* max item in .data file */
Description *Case=0, /* data items */
*SaveCase=0; /* items in original order */
DiscrValue *MaxAttVal=0; /* number of values for each att */
char *SpecialStatus=0; /* special att treatment */
Definition *AttDef=0; /* definitions of implicit atts */
String *AttName=0, /* att names */
**AttValName=0; /* att value names */
int VERBOSITY=0, /* verbosity level (0 = none) */
MAXCONDATTS=4, /* max conditioning atts */
MAXOUT=0; /* max reported anoms */
Boolean SIFT=true, /* write sift file */
LIST=false, /* generate list of possible anoms */
TargetSaved; /* has current classatt been saved? */
CaseCount CMINITEMS=0, /* min group when testing contin */
DMINITEMS=0, /* min group when testing discr */
SampleSize; /* min sample size */
float MINABNORM=8, /* SDs for abnormal value */
CF=50; /* reporting level */
double **Prior=0, /* [att][discr value] */
*LogCaseNo=0, /* table of log2 */
*Rand=0; /* random numbers */
unsigned char *Prec=0;
int LastLevel=-1; /* level of last condition saved */
char Fn[512]; /* file name */
Boolean *UseLogs=0, /* use log transformation */
*SomeMiss=0, /* att has missing values */
*SomeNA=0; /* att has N/A values */
ContValue *LowTail=0, /* lowest value analysed */
*HighTail=0; /* highest ditto */
Clust *Cluster=0; /* clusters found */
int NClust=0,
ClustSpace=0;
EnvRec GEnv; /* global environment */
FILE *Sf=0; /* sift file */
Tree T=0; /* intermediate tree */
String FileStem="undefined";
gritbot.c 0000664 0000764 0000764 00000021003 11501534524 012602 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* GritBot */
/* ------- */
/* */
/* GritBot's function is to locate potential anomalies in data. */
/* A potential anomaly is defined as a value of an attribute */
/* that is "surprising" given the values of the other attributes */
/* (all of which must be unsurprising). */
/* */
/* Of course, this is difficult without having a model of how the */
/* attribute values interrelate! The fundamental idea behind */
/* GritBot is that anomalies will show up as extreme deviations */
/* in populations of "similar" cases. GritBot thus searches */
/* for regions of the attribute space in which the values of one */
/* attribute are relatively uniform, and checks for small numbers */
/* of cases that have unusual values of this attribute but */
/* unexceptional values of all other attributes. */
/* */
/* Several parameters govern GritBot's behavior: */
/* */
/* MAXFRAC the approximate maximum percentage of outliers */
/* in any subset of cases (default 1%). */
/* The maximum number of permissible outliers in */
/* N cases is 2 SDs above the expected N * MAXFRAC. */
/* MAXFRAC must be small -- GritBot cannot find */
/* anomalies unless the data is fairly clean. */
/* */
/* Not user-adjustable. */
/* */
/* MAXNORM the maximum number of SDs by which a "normal" */
/* (non-anomalous) value can differ from the mean */
/* over the subset (default 2.67). */
/* */
/* Relevant only to continuous attributes. */
/* Not user-adjustable. */
/* */
/* MINABNORM the minimum number of SDs by which an anomaly */
/* should differ from the mean of the subset */
/* (default 8). This value is adjusted to reflect */
/* the user-specified filtering level percent (CF): */
/* */
/* CF=0 -> MINABNORM=4 */
/* CF=50 -> MINABNORM=8 */
/* CF=100 -> MINABNORM=20 */
/* */
/* For discrete attributes, MINABNORM is used to */
/* set a maximum impurity threshold as */
/* */
/* impurity / prior < 1 / (MINABNORM^2) */
/* */
/* Impurities greater than or equal to this value */
/* are not regarded as anomalies. */
/* */
/* MAXCONDATTS the maximum number of attributes that can be */
/* used to describe a subset of cases (default 4). */
/* Continuous attributes can be used to specify */
/* either a lower limit, an upper limit, or a range. */
/* */
/* User-adjustable. */
/* */
/* CMINITEMS the minimum number of cases in a subset containing */
/* a potentially anomalous continuous value (value: */
/* 0.5% of cases or 35, whichever is greater). */
/* */
/* Not user-adjustable. */
/* */
/* DMINITEMS the minimum number of cases in a subset containing */
/* a potentially anomalous discrete value (value: */
/* currently same as CMINITEMS */
/* */
/* Not user-adjustable. */
/* */
/* */
/* The GritBot procedure can be summarised as: */
/* */
/* for each continuous attribute in turn: */
/* { */
/* check whether a log transformation should be applied */
/* remove any possibly multinomial tails */
/* } */
/* */
/* for each attribute A in turn: */
/* { */
/* remove cases with unknown values of A */
/* recursively partition the cases using attributes other */
/* than A, trying to produce maximally homogeneous subsets */
/* * continuous attributes -- minimize variance of A */
/* * discrete attributes -- minimize impurity of A */
/* test each subset for anomalies as above */
/* } */
/* */
/* report anomalies found */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
#include
#include
#include
#define SetFOpt(V) V = strtod(OptArg, &EndPtr);\
if ( ! EndPtr || *EndPtr != '\00' ) break;\
ArgOK = true
#define SetIOpt(V) V = strtol(OptArg, &EndPtr, 10);\
if ( ! EndPtr || *EndPtr != '\00' ) break;\
ArgOK = true
int main(int Argc, char *Argv[])
/* ---- */
{
int o;
extern String OptArg, Option;
char *EndPtr;
Boolean FirstTime=true, ArgOK;
double StartTime;
FILE *F;
Attribute Att;
struct rlimit RL;
/* Make sure there is a largish runtime stack */
getrlimit(RLIMIT_STACK, &RL);
RL.rlim_cur = Max(RL.rlim_cur, 16777216);
if ( RL.rlim_max > 0 ) /* -1 if unlimited */
{
RL.rlim_cur = Min(RL.rlim_max, RL.rlim_cur);
}
setrlimit(RLIMIT_STACK, &RL);
StartTime = ExecTime();
PrintHeader("");
/* Process options */
while ( (o = ProcessOption(Argc, Argv, "f+v+l+c+n+srh")) )
{
if ( FirstTime )
{
fprintf(Of, "\n " T_Options ":\n");
FirstTime = false;
}
ArgOK = false;
switch (o)
{
case 'f': FileStem = OptArg;
fprintf(Of, F_Application, FileStem);
ArgOK = true;
break;
#ifdef VerbOpt
case 'v': SetIOpt(VERBOSITY);
fprintf(Of, "\tVerbosity level %d\n", VERBOSITY);
ArgOK = true;
break;
#endif
case 'l': SetFOpt(CF);
fprintf(Of, F_Filtering, CF);
Check(CF, 0, 100);
MINABNORM = ( CF < 50 ? 0.08 * CF + 4 : 0.24 * CF - 4 );
break;
case 'c': SetIOpt(MAXCONDATTS);
fprintf(Of, F_MaxConds, MAXCONDATTS);
Check(MAXCONDATTS, 0, 100);
break;
case 'n': SetIOpt(MAXOUT);
fprintf(Of, F_MaxOut, MAXOUT);
Check(MAXOUT, 1, 1000000);
break;
case 's': SIFT = false;
fprintf(Of, F_NoSift);
ArgOK = true;
break;
case 'r': LIST = true;
fprintf(Of, F_ListAnoms);
ArgOK = true;
break;
}
if ( ! ArgOK )
{
if ( o != 'h' )
{
fprintf(Of, F_UnrecogOpt, Option);
}
fprintf(Of, F_OptList);
Goodbye(1);
}
}
/* Get information on training data */
if ( ! (F = GetFile(".names", "r")) ) Error(NOFILE, "", "");
GetNames(F);
NotifyStage(READDATA);
Progress(-1);
if ( ! (F = GetFile(".data", "r")) ) Error(NOFILE, "", "");
GetData(F, true);
fprintf(Of, F_ReadData(MaxCase+1, MaxAtt, FileStem));
LastDataCase = MaxCase;
/* If there is a .test file, include it too */
if ( (F = GetFile(".test", "r")) )
{
NotifyStage(READTEST);
Progress(-1);
GetData(F, false);
fprintf(Of, F_ReadTest(MaxCase - LastDataCase, FileStem));
}
MemTrim();
/* Note any attribute exclusions/inclusions */
if ( AttExIn )
{
fprintf(Of, ( AttExIn == -1 ? F_AttNotChecked : F_AttChecked ));
ForEach(Att, 1, MaxAtt)
{
if ( ( StatBit(Att, SKIP) > 0 ) == ( AttExIn == -1 ) )
{
fprintf(Of, " %s\n", AttName[Att]);
}
}
}
/* Save a copy of original order */
SaveCase = Alloc(MaxCase+1, Description);
memcpy(SaveCase, Case, (MaxCase+1) * sizeof(Description));
CheckData();
/* Restore the original order */
Free(Case);
Case = SaveCase;
SaveCase = Nil;
ReportOutliers();
fprintf(Of, F_Time(ExecTime() - StartTime));
#ifdef VerbOpt
FreeDAC();
#endif
return 0;
}
implicitatt.c 0000664 0000764 0000764 00000055163 11501534524 013471 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Routines to handle implicitly-defined attributes */
/* ------------------------------------------------ */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
#include
char *Buff; /* buffer for input characters */
int BuffSize, BN; /* size and index of next character */
EltRec *TStack; /* expression stack model */
int TStackSize, TSN; /* size of stack and index of next entry */
int DefSize, DN; /* size of definition and next element */
Boolean PreviousError; /* to avoid parasitic errors */
AttValue _UNK, /* quasi-constant for unknown value */
_NA; /* ditto for not applicable */
#define FailSyn(Msg) {DefSyntaxError(Msg); return false;}
#define FailSem(Msg) {DefSemanticsError(Fi, Msg, OpCode); return false;}
typedef union _xstack_elt
{
DiscrValue _discr_val;
ContValue _cont_val;
String _string_val;
}
XStackElt;
#define cval _cont_val
#define sval _string_val
#define dval _discr_val
#ifndef INSPECT
/*************************************************************************/
/* */
/* A definition is handled in two stages: */
/* - The definition is read (up to a line ending with a period) */
/* replacing multiple whitespace characters with one space */
/* - The definition is then read (using a recursive descent */
/* parser), building up a reverse polish expression */
/* Syntax and semantics errors are flagged */
/* */
/*************************************************************************/
void ImplicitAtt(FILE *Nf)
/* ----------- */
{
#ifdef CUBIST
_UNK.cval = UNKNOWN;
#else
_UNK.dval = UNKNOWN;
#endif
_NA.dval = NA;
/* Get definition as a string in Buff */
ReadDefinition(Nf);
PreviousError = false;
BN = 0;
/* Allocate initial stack and attribute definition */
TStack = Alloc(TStackSize=50, EltRec);
TSN = 0;
AttDef[MaxAtt] = Alloc(DefSize = 100, DefElt);
DN = 0;
/* Parse Buff as an expression terminated by a period */
Expression();
if ( ! Find(".") ) DefSyntaxError("'.' ending definition");
/* Final check -- defined attribute must not be of type String */
if ( ! PreviousError )
{
if ( DN == 1 && DefOp(AttDef[MaxAtt][0]) == OP_ATT )
{
Error(SAMEATT, AttName[ (long) DefSVal(AttDef[MaxAtt][0]) ], Nil);
PreviousError = true;
}
if ( TStack[0].Type == 'B' )
{
/* Defined attributes should never have a value N/A */
MaxAttVal[MaxAtt] = 3;
AttValName[MaxAtt] = AllocZero(4, String);
AttValName[MaxAtt][1] = strdup("??");
AttValName[MaxAtt][2] = strdup("t");
AttValName[MaxAtt][3] = strdup("f");
}
else
{
MaxAttVal[MaxAtt] = 0;
}
}
if ( PreviousError )
{
DN = 0;
SpecialStatus[MaxAtt] = EXCLUDE;
}
/* Write a terminating marker */
DefOp(AttDef[MaxAtt][DN]) = OP_END;
Free(Buff);
Free(TStack);
}
/*************************************************************************/
/* */
/* Read the text of a definition. Skip comments, collapse */
/* multiple whitespace characters. */
/* */
/*************************************************************************/
void ReadDefinition(FILE *f)
/* -------------- */
{
Boolean LastWasPeriod=false;
char c;
Buff = Alloc(BuffSize=50, char);
BN = 0;
while ( true )
{
c = InChar(f);
if ( c == '|' ) SkipComment;
if ( c == EOF || c == '\n' && LastWasPeriod )
{
/* The definition is complete. Add a period if it's
not there already and terminate the string */
if ( ! LastWasPeriod ) Append('.');
Append(0);
return;
}
if ( Space(c) )
{
Append(' ');
}
else
if ( c == '\\' )
{
/* Escaped character -- bypass any special meaning */
Append(InChar(f));
}
else
{
LastWasPeriod = ( c == '.' );
Append(c);
}
}
}
/*************************************************************************/
/* */
/* Append a character to Buff, resizing it if necessary */
/* */
/*************************************************************************/
void Append(char c)
/* ------ */
{
if ( c == ' ' && (! BN || Buff[BN-1] == ' ' ) ) return;
if ( BN >= BuffSize )
{
Realloc(Buff, BuffSize += 50, char);
}
Buff[BN++] = c;
}
/*************************************************************************/
/* */
/* Recursive descent parser with syntax error checking. */
/* The reverse polish is built up by calls to Dump() and DumpOp(), */
/* which also check for semantic validity. */
/* */
/* For possible error messages, each routine also keeps track of */
/* the beginning of the construct that it recognises (in Fi). */
/* */
/*************************************************************************/
Boolean Expression()
/* ---------- */
{
int Fi=BN;
if ( Buff[BN] == ' ' ) BN++;
if ( ! Conjunct() ) FailSyn("expression");
while ( Find("or") )
{
BN += 2;
if ( ! Conjunct() ) FailSyn("expression");
DumpOp(OP_OR, Fi);
}
return true;
}
Boolean Conjunct()
/* -------- */
{
int Fi=BN;
if ( ! SExpression() ) FailSyn("expression");
while ( Find("and") )
{
BN += 3;
if ( ! SExpression() ) FailSyn("expression");
DumpOp(OP_AND, Fi);
}
return true;
}
String RelOps[] = {">=", "<=", "!=", "<>", ">", "<", "=", (String) 0};
Boolean SExpression()
/* ----------- */
{
int o, Fi=BN;
if ( ! AExpression() ) FailSyn("expression");
if ( (o = FindOne(RelOps)) >= 0 )
{
BN += strlen(RelOps[o]);
if ( ! AExpression() ) FailSyn("expression");
DumpOp(( o == 0 ? OP_GE :
o == 1 ? OP_LE :
o == 4 ? OP_GT :
o == 5 ? OP_LT :
o == 2 || o == 3 ?
( TStack[TSN-1].Type == 'S' ? OP_SNE : OP_NE ) :
( TStack[TSN-1].Type == 'S' ? OP_SEQ : OP_EQ ) ), Fi);
}
return true;
}
String AddOps[] = {"+", "-", (String) 0};
Boolean AExpression()
/* ----------- */
{
int o, Fi=BN;
if ( Buff[BN] == ' ' ) BN++;
if ( (o = FindOne(AddOps)) >= 0 )
{
BN += 1;
}
if ( ! Term() ) FailSyn("expression");
if ( o == 1 ) DumpOp(OP_UMINUS, Fi);
while ( (o = FindOne(AddOps)) >= 0 )
{
BN += 1;
if ( ! Term() ) FailSyn("arithmetic expression");
DumpOp((char)(OP_PLUS + o), Fi);
}
return true;
}
String MultOps[] = {"*", "/", "%", (String) 0};
Boolean Term()
/* ---- */
{
int o, Fi=BN;
if ( ! Factor() ) FailSyn("expression");
while ( (o = FindOne(MultOps)) >= 0 )
{
BN += 1;
if ( ! Factor() ) FailSyn("arithmetic expression");
DumpOp((char)(OP_MULT + o), Fi);
}
return true;
}
Boolean Factor()
/* ---- */
{
int Fi=BN;
if ( ! Primary() ) FailSyn("value");
while ( Find("^") )
{
BN += 1;
if ( ! Primary() ) FailSyn("exponent");
DumpOp(OP_POW, Fi);
}
return true;
}
Boolean Primary()
/* ------- */
{
if ( Atom() )
{
return true;
}
else
if ( Find("(") )
{
BN++;
if ( ! Expression() ) FailSyn("expression in parentheses");
if ( ! Find(")") ) FailSyn("')'");
BN++;
return true;
}
else
{
FailSyn("attribute, value, or '('");
}
}
String Funcs[] = {"sin", "cos", "tan", "log", "exp", "int", (String) 0};
Boolean Atom()
/* ---- */
{
char *EndPtr, *Str, Date[11], Time[9];
int o, FirstBN, Fi=BN;
ContValue F;
Attribute Att;
if ( Buff[BN] == ' ' ) BN++;
if ( Buff[BN] == '"' )
{
FirstBN = ++BN;
while ( Buff[BN] != '"' )
{
if ( ! Buff[BN] ) FailSyn("closing '\"'");
BN++;
}
/* Make a copy of the string without double quotes */
Buff[BN] = '\00';
Str = strdup(Buff + FirstBN);
Buff[BN++] = '"';
Dump(OP_STR, 0, Str, Fi);
}
else
if ( (Att = FindAttName()) )
{
BN += strlen(AttName[Att]);
Dump(OP_ATT, 0, (String) (long) Att, Fi);
}
else
if ( isdigit(Buff[BN]) )
{
/* Check for date or time first */
if ( ( Buff[BN+4] == '/' && Buff[BN+7] == '/' ||
Buff[BN+4] == '-' && Buff[BN+7] == '-' )&&
isdigit(Buff[BN+1]) && isdigit(Buff[BN+2]) &&
isdigit(Buff[BN+3]) &&
isdigit(Buff[BN+5]) && isdigit(Buff[BN+6]) &&
isdigit(Buff[BN+8]) && isdigit(Buff[BN+9]) )
{
memcpy(Date, Buff+BN, 10);
Date[10] = '\00';
if ( (F = DateToDay(Date)) == 0 )
{
Error(BADDEF1, Date, "date");
}
BN += 10;
}
else
if ( Buff[BN+2] == ':' && Buff[BN+5] == ':' &&
isdigit(Buff[BN+1]) &&
isdigit(Buff[BN+3]) && isdigit(Buff[BN+4]) &&
isdigit(Buff[BN+6]) && isdigit(Buff[BN+7]) )
{
memcpy(Time, Buff+BN, 8);
Time[8] = '\00';
if ( (F = TimeToSecs(Time)) == 0 )
{
Error(BADDEF1, Time, "time");
}
BN += 8;
}
else
{
F = strtod(Buff+BN, &EndPtr);
/* Check for period after integer */
if ( EndPtr > Buff+BN+1 && *(EndPtr-1) == '.' )
{
EndPtr--;
}
BN = EndPtr - Buff;
}
Dump(OP_NUM, F, Nil, Fi);
}
else
if ( (o = FindOne(Funcs)) >= 0 )
{
BN += 3;
if ( ! Find("(") ) FailSyn("'(' after function name");
BN++;
if ( ! Expression() ) FailSyn("expression");
if ( ! Find(")") ) FailSyn("')' after function argument");
BN++;
DumpOp((char)(OP_SIN + o), Fi);
}
else
if ( Buff[BN] == '?' )
{
BN++;
if ( TStack[TSN-1].Type == 'N' )
{
Dump(OP_NUM, _UNK.cval, Nil, Fi);
}
else
{
Dump(OP_STR, 0, Nil, Fi);
}
}
else
if ( ! memcmp(Buff+BN, "N/A", 3) )
{
BN += 3;
if ( TStack[TSN-1].Type == 'N' )
{
Dump(OP_NUM, _NA.cval, Nil, Fi);
}
else
{
Dump(OP_STR, 0, strdup("N/A"), Fi);
}
}
else
{
return false;
}
return true;
}
/*************************************************************************/
/* */
/* Skip spaces and check for specific string */
/* */
/*************************************************************************/
Boolean Find(String S)
/* ---- */
{
if ( Buff[BN] == ' ' ) BN++;
return ( ! Buff[BN] ? false : ! memcmp(Buff+BN, S, strlen(S)) );
}
/*************************************************************************/
/* */
/* Find one of a zero-terminated list of alternatives */
/* */
/*************************************************************************/
int FindOne(String *Alt)
/* ------- */
{
int a;
for ( a = 0 ; Alt[a] ; a++ )
{
if ( Find(Alt[a]) ) return a;
}
return -1;
}
/*************************************************************************/
/* */
/* Find an attribute name */
/* */
/*************************************************************************/
Attribute FindAttName()
/* ----------- */
{
Attribute Att, LongestAtt=0;
ForEach(Att, 1, MaxAtt-1)
{
if ( ! Exclude(Att) && Find(AttName[Att]) )
{
if ( ! LongestAtt ||
strlen(AttName[Att]) > strlen(AttName[LongestAtt]) )
{
LongestAtt = Att;
}
}
}
return LongestAtt;
}
/*************************************************************************/
/* */
/* Error message routines. Syntax errors come from the */
/* recursive descent parser, semantics errors from the routines */
/* that build up the equivalent polish */
/* */
/*************************************************************************/
void DefSyntaxError(String Msg)
/* -------------- */
{
String RestOfText;
int i=10;
if ( ! PreviousError )
{
RestOfText = Buff + BN;
/* Abbreviate text if longer than 12 characters */
if ( CharWidth(RestOfText) > 12 )
{
#ifdef UTF8
/* Find beginning of UTF-8 character */
for ( ; (RestOfText[i] & 0x80) ; i++)
;
#endif
RestOfText[i] = RestOfText[i+1] = '.';
}
Error(BADDEF1, RestOfText, Msg);
PreviousError = true;
}
}
void DefSemanticsError(int Fi, String Msg, int OpCode)
/* ----------------- */
{
char Exp[1000], XMsg[1000], Op[1000];
if ( ! PreviousError )
{
/* Abbreviate the input if necessary */
if ( BN - Fi > 23 )
{
sprintf(Exp, "%.10s...%.10s", Buff+Fi, Buff+BN-10);
}
else
{
sprintf(Exp, "%.*s", BN - Fi, Buff+Fi);
}
switch ( OpCode )
{
case OP_AND: sprintf(Op, "%s", "and"); break;
case OP_OR: sprintf(Op, "%s", "or"); break;
case OP_SEQ:
case OP_EQ: sprintf(Op, "%s", "="); break;
case OP_SNE:
case OP_NE: sprintf(Op, "%s", "<>"); break;
case OP_GT: sprintf(Op, "%s", ">"); break;
case OP_GE: sprintf(Op, "%s", ">="); break;
case OP_LT: sprintf(Op, "%s", "<"); break;
case OP_LE: sprintf(Op, "%s", "<="); break;
case OP_PLUS: sprintf(Op, "%s", "+"); break;
case OP_MINUS: sprintf(Op, "%s", "-"); break;
case OP_UMINUS: sprintf(Op, "%s", "unary -"); break;
case OP_MULT: sprintf(Op, "%s", "*"); break;
case OP_DIV: sprintf(Op, "%s", "/"); break;
case OP_MOD: sprintf(Op, "%s", "%"); break;
case OP_POW: sprintf(Op, "%s", "^"); break;
case OP_SIN: sprintf(Op, "%s", "sin"); break;
case OP_COS: sprintf(Op, "%s", "cos"); break;
case OP_TAN: sprintf(Op, "%s", "tan"); break;
case OP_LOG: sprintf(Op, "%s", "log"); break;
case OP_EXP: sprintf(Op, "%s", "exp"); break;
case OP_INT: sprintf(Op, "%s", "int");
}
sprintf(XMsg, "%s with '%s'", Msg, Op);
Error(BADDEF2, Exp, XMsg);
PreviousError = true;
}
}
/*************************************************************************/
/* */
/* Reverse polish routines. These use a model of the stack */
/* during expression evaluation to detect type conflicts etc */
/* */
/*************************************************************************/
void Dump(char OpCode, ContValue F, String S, int Fi)
/* ---- */
{
if ( Buff[Fi] == ' ' ) Fi++;
if ( ! UpdateTStack(OpCode, F, S, Fi) ) return;
/* Make sure enough room for this element */
if ( DN >= DefSize-1 )
{
Realloc(AttDef[MaxAtt], DefSize += 100, DefElt);
}
DefOp(AttDef[MaxAtt][DN]) = OpCode;
if ( OpCode == OP_ATT || OpCode == OP_STR )
{
DefSVal(AttDef[MaxAtt][DN]) = S;
}
else
{
DefNVal(AttDef[MaxAtt][DN]) = F;
}
DN++;
}
void DumpOp(char OpCode, int Fi)
/* ------ */
{
Dump(OpCode, 0, Nil, Fi);
}
Boolean UpdateTStack(char OpCode, ContValue F, String S, int Fi)
/* ------------ */
{
if ( TSN >= TStackSize )
{
Realloc(TStack, TStackSize += 50, EltRec);
}
switch ( OpCode )
{
case OP_ATT:
TStack[TSN].Type = ( Continuous((long) S) ? 'N' : 'S' );
break;
case OP_NUM:
TStack[TSN].Type = 'N';
break;
case OP_STR:
TStack[TSN].Type = 'S';
break;
case OP_AND:
case OP_OR:
if ( TStack[TSN-2].Type != 'B' || TStack[TSN-1].Type != 'B' )
{
FailSem("non-logical value");
}
TSN -= 2;
break;
case OP_EQ:
case OP_NE:
if ( TStack[TSN-2].Type != TStack[TSN-1].Type )
{
FailSem("incompatible values");
}
TSN -= 2;
TStack[TSN].Type = 'B';
break;
case OP_GT:
case OP_GE:
case OP_LT:
case OP_LE:
if ( TStack[TSN-2].Type != 'N' || TStack[TSN-1].Type != 'N' )
{
FailSem("non-arithmetic value");
}
TSN -= 2;
TStack[TSN].Type = 'B';
break;
case OP_SEQ:
case OP_SNE:
if ( TStack[TSN-2].Type != 'S' || TStack[TSN-1].Type != 'S' )
{
FailSem("incompatible values");
}
TSN -= 2;
TStack[TSN].Type = 'B';
break;
case OP_PLUS:
case OP_MINUS:
case OP_MULT:
case OP_DIV:
case OP_MOD:
case OP_POW:
if ( TStack[TSN-2].Type != 'N' || TStack[TSN-1].Type != 'N' )
{
FailSem("non-arithmetic value");
}
TSN -= 2;
break;
case OP_UMINUS:
if ( TStack[TSN-1].Type != 'N' )
{
FailSem("non-arithmetic value");
}
TSN--;
break;
case OP_SIN:
case OP_COS:
case OP_TAN:
case OP_LOG:
case OP_EXP:
case OP_INT:
if ( TStack[TSN-1].Type != 'N' )
{
FailSem("non-arithmetic argument");
}
TSN--;
}
TStack[TSN].Fi = Fi;
TStack[TSN].Li = BN-1;
TSN++;
return true;
}
#endif
/*************************************************************************/
/* */
/* Evaluate an implicit attribute for a case */
/* */
/*************************************************************************/
#define CUnknownVal(AV) (AV.cval==_UNK.cval)
#define DUnknownVal(AV) (! AV.dval)
#define DUNA(a) (DUnknownVal(XStack[a]) || NotApplicVal(XStack[a]))
#define CUNA(a) (CUnknownVal(XStack[a]) || NotApplicVal(XStack[a]))
#define C1(x) (CUNA(XSN-1) ? _UNK.cval : (x))
#define C2(x) (CUNA(XSN-1) || CUNA(XSN-2) ? _UNK.cval : (x))
#define CD2(x) (CUNA(XSN-1) || CUNA(XSN-2) ? 0 : (x))
#define D2(x) (DUNA(XSN-1) || DUNA(XSN-2) ? 0 : (x))
AttValue EvaluateDef(Definition D, Description Case)
/* ----------- */
{
XStackElt XStack[100]; /* allows 100-level nesting */
int XSN=0, DN, bv1, bv2, Mult;
double cv1, cv2;
String sv1, sv2;
Attribute Att;
DefElt DElt;
AttValue ReturnVal;
for ( DN = 0 ; ; DN++)
{
switch ( DefOp((DElt = D[DN])) )
{
case OP_ATT:
Att = (long) DefSVal(DElt);
if ( Continuous(Att) )
{
XStack[XSN++].cval = CVal(Case, Att);
}
else
{
XStack[XSN++].sval =
( Unknown(Case, Att) && ! NotApplic(Case, Att) ? 0 :
AttValName[Att][XDVal(Case, Att)] );
}
break;
case OP_NUM:
XStack[XSN++].cval = DefNVal(DElt);
break;
case OP_STR:
XStack[XSN++].sval = DefSVal(DElt);
break;
case OP_AND:
bv1 = XStack[XSN-2].dval;
bv2 = XStack[XSN-1].dval;
XStack[XSN-2].dval = ( bv1 == 3 || bv2 == 3 ? 3 :
D2(bv1 == 2 && bv2 == 2 ? 2 : 3) );
XSN--;
break;
case OP_OR:
bv1 = XStack[XSN-2].dval;
bv2 = XStack[XSN-1].dval;
XStack[XSN-2].dval = ( bv1 == 2 || bv2 == 2 ? 2 :
D2(bv1 == 2 || bv2 == 2 ? 2 : 3) );
XSN--;
break;
case OP_EQ:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].dval = ( cv1 == cv2 ? 2 : 3 );
XSN--;
break;
case OP_NE:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].dval = ( cv1 != cv2 ? 2 : 3 );
XSN--;
break;
case OP_GT:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].dval = CD2(cv1 > cv2 ? 2 : 3);
XSN--;
break;
case OP_GE:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].dval = CD2(cv1 >= cv2 ? 2 : 3);
XSN--;
break;
case OP_LT:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].dval = CD2(cv1 < cv2 ? 2 : 3);
XSN--;
break;
case OP_LE:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].dval = CD2(cv1 <= cv2 ? 2 : 3);
XSN--;
break;
case OP_SEQ:
sv1 = XStack[XSN-2].sval;
sv2 = XStack[XSN-1].sval;
XStack[XSN-2].dval =
( ! sv1 && ! sv2 ? 2 :
! sv1 || ! sv2 ? 3 :
! strcmp(sv1, sv2) ? 2 : 3 );
XSN--;
break;
case OP_SNE:
sv1 = XStack[XSN-2].sval;
sv2 = XStack[XSN-1].sval;
XStack[XSN-2].dval =
( ! sv1 && ! sv2 ? 3 :
! sv1 || ! sv2 ? 2 :
strcmp(sv1, sv2) ? 2 : 3 );
XSN--;
break;
case OP_PLUS:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].cval = C2(cv1 + cv2);
XSN--;
break;
case OP_MINUS:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].cval = C2(cv1 - cv2);
XSN--;
break;
case OP_MULT:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].cval = C2(cv1 * cv2);
XSN--;
break;
case OP_DIV:
/* Note: have to set precision of result */
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
if ( ! cv2 ||
CUnknownVal(XStack[XSN-2]) ||
CUnknownVal(XStack[XSN-1]) ||
NotApplicVal(XStack[XSN-2]) ||
NotApplicVal(XStack[XSN-1]) )
{
XStack[XSN-2].cval = _UNK.cval;
}
else
{
Mult = Denominator(cv1);
cv1 = cv1 / cv2;
while ( fabs(cv2) > 1 )
{
Mult *= 10;
cv2 /= 10;
}
XStack[XSN-2].cval = rint(cv1 * Mult) / Mult;
}
XSN--;
break;
case OP_MOD:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].cval = C2(fmod(cv1, cv2));
XSN--;
break;
case OP_POW:
cv1 = XStack[XSN-2].cval;
cv2 = XStack[XSN-1].cval;
XStack[XSN-2].cval =
( CUNA(XSN-1) || CUNA(XSN-2) ||
( cv1 < 0 && ceil(cv2) != cv2 ) ? _UNK.cval :
pow(cv1, cv2) );
XSN--;
break;
case OP_UMINUS:
cv1 = XStack[XSN-1].cval;
XStack[XSN-1].cval = C1(-cv1);
break;
case OP_SIN:
cv1 = XStack[XSN-1].cval;
XStack[XSN-1].cval = C1(sin(cv1));
break;
case OP_COS:
cv1 = XStack[XSN-1].cval;
XStack[XSN-1].cval = C1(cos(cv1));
break;
case OP_TAN:
cv1 = XStack[XSN-1].cval;
XStack[XSN-1].cval = C1(tan(cv1));
break;
case OP_LOG:
cv1 = XStack[XSN-1].cval;
XStack[XSN-1].cval =
( CUNA(XSN-1) || cv1 <= 0 ? _UNK.cval : log(cv1) );
break;
case OP_EXP:
cv1 = XStack[XSN-1].cval;
XStack[XSN-1].cval = C1(exp(cv1));
break;
case OP_INT:
cv1 = XStack[XSN-1].cval;
XStack[XSN-1].cval = C1(rint(cv1));
break;
case OP_END:
ReturnVal.cval = XStack[0].cval; /* cval >= dval bytes */
return ReturnVal;
}
}
}
inspect.c 0000664 0000764 0000764 00000037124 11501534524 012610 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Inspect: Use saved .sift file to check new cases. */
/* ------------------------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
/*************************************************************************/
/* */
/* Global Data */
/* ----------- */
/* */
/*************************************************************************/
Attribute ClassAtt=0, /* attribute to use as class */
LabelAtt; /* attribute to use as case ID */
int MaxAtt, /* max att number */
MaxDiscrVal=3, /* max discrete values for any att */
MaxLabel=0, /* max characters in case label */
LineNo=0, /* input line number */
ErrMsgs=0, /* errors found */
TSBase=0; /* base day for time stamps */
CaseNo MaxCase=-1, /* max data item number */
LastDataCase, /* max item in .data file */
*GLp; /* last case stack */
Description *Case=Nil, /* data items */
*SaveCase=Nil; /* items in original order */
DiscrValue *MaxAttVal=Nil; /* number of values for each att */
char *SpecialStatus=Nil; /* special att treatment */
Boolean *UseLogs=Nil, /* use log transformation */
*SomeNA=Nil; /* att has missing values */
Definition *AttDef=Nil; /* definitions of implicit atts */
String *AttName=Nil, /* att names */
**AttValName=Nil; /* att value names */
Boolean SIFT=true, /* write sift file */
LIST=false, /* list case numbers */
TargetSaved; /* has current classatt been saved? */
int MAXOUT=0; /* max anoms reported */
float MINABNORM=8; /* SDs for abnormal value */
unsigned char *Prec=Nil; /* [att] */
int LastLevel=0;
Set LeftSS=Nil; /* temporary subset */
float *Surprise=Nil; /* temporary DProb values */
char Fn[512]; /* file name */
ContValue *LowTail=Nil, /* lowest value analysed */
*HighTail=Nil; /* highest ditto */
Clust *Cluster=Nil; /* clusters found */
int NClust=0,
ClustSpace=0;
CaveatRec *Caveat=Nil; /* caveat records */
int NCaveat; /* active caveats */
EnvRec GEnv; /* sift environment */
FILE *Sf=0; /* sift file */
String FileStem="undefined";
#define SetIOpt(V) V = strtol(OptArg, &EndPtr, 10);\
if ( ! EndPtr || *EndPtr != '\00' ) break;\
ArgOK = true
/*************************************************************************/
/* */
/* Main */
/* */
/*************************************************************************/
int main(int Argc, char *Argv[])
/* ---- */
{
CaseNo i;
FILE *F;
int o;
char *EndPtr;
Boolean FirstTime=true, ArgOK;
double StartTime;
extern String OptArg, Option;
SIFT = false; /* important for CleanUp()! */
StartTime = ExecTime();
PrintHeader(" Inspector");
/* Process options */
while ( (o = ProcessOption(Argc, Argv, "f+n+rh")) )
{
if ( FirstTime )
{
fprintf(Of, "\n " T_Options ":\n");
FirstTime = false;
}
ArgOK = false;
switch (o)
{
case 'f': FileStem = OptArg;
fprintf(Of, F_Application, FileStem);
ArgOK = true;
break;
case 'n': SetIOpt(MAXOUT);
fprintf(Of, F_MaxOut, MAXOUT);
Check(MAXOUT, 1, 1000000);
break;
case 'r': LIST = true;
fprintf(Of, F_ListAnoms);
ArgOK = true;
break;
case '?': printf(" **Unrecognised option %s\n", Option);
exit(1);
}
if ( ! ArgOK )
{
if ( o != 'h' )
{
fprintf(Of, F_UnrecogOpt, Option);
}
fprintf(Of, F_CkOptList);
exit(1);
}
}
/* Open the .sift file and recover attribute information */
CheckFile(".sift", false);
fprintf(Of, F_ReadSift, FileStem);
if ( ! (F = GetFile(".cases", "r")) ) Error(NOFILE, "", "");
GetData(F, true);
fprintf(Of, F_ReadCases(MaxCase+1, MaxAtt, FileStem));
LastDataCase = MaxCase;
/* Remember original case order */
SaveCase = Alloc(MaxCase+1, Description);
ForEach(i, 0, MaxCase)
{
SaveCase[i] = Case[i];
}
/* Check the cases for anomalies using information recorded
in the .sift file */
ProcessSift();
/* Restore original case order before reporting potential anomalies */
Free(Case);
Case = SaveCase;
SaveCase = Nil;
ReportOutliers();
fprintf(Of, F_Time(ExecTime() - StartTime));
CleanupSift();
return 0;
}
/*************************************************************************/
/* */
/* Deallocate all dynamic storage */
/* */
/*************************************************************************/
void CleanupSift()
/* ----------- */
{
Attribute Att;
int i, d;
if ( Sf )
{
fclose(Sf); Sf=0;
}
/* Any stuff from ProcessSift() */
FreeUnlessNil(LeftSS); LeftSS=Nil;
FreeUnlessNil(Surprise); Surprise=Nil;
FreeUnlessNil(SomeNA); SomeNA=Nil;
FreeUnlessNil(GLp); GLp=Nil;
FreeUnlessNil(Prec); Prec=Nil;
FreeUnlessNil(UseLogs); UseLogs=Nil;
FreeUnlessNil(LowTail); LowTail=Nil;
FreeUnlessNil(HighTail); HighTail=Nil;
if ( Caveat )
{
ForEach(Att, 1, MaxAtt)
{
FreeUnlessNil(Caveat[Att-1].Subset);
}
Free(Caveat); Caveat=Nil;
}
Free(GEnv.Possible);
Free(GEnv.Tested);
ForEach(i, 0, GEnv.MaxLevel-1)
{
FreeUnlessNil(GEnv.Test[i].Left);
}
Free(GEnv.Test);
if ( MaxCase >= 0 )
{
FreeData(); MaxCase=-1;
}
FreeUnlessNil(SaveCase); SaveCase=Nil;
FreeNames();
if ( NClust > 0 )
{
ForEach(d, 0, NClust-1)
{
FreeClust(Cluster[d]);
}
}
NClust = ClustSpace = 0;
FreeUnlessNil(Cluster); Cluster=Nil;
NotifyStage(0);
Progress(0);
}
/*************************************************************************/
/* */
/* Check entries in .sift file */
/* */
/*************************************************************************/
void ProcessSift()
/* ----------- */
{
int E;
Attribute Att;
/* Find maximum discrete value */
ForEach(Att, 1, MaxAtt)
{
if ( Discrete(Att) && ! Exclude(Att) && MaxAttVal[Att] > MaxDiscrVal )
{
MaxDiscrVal = MaxAttVal[Att];
}
}
/* Allocate variables used globally */
LeftSS = Alloc((MaxDiscrVal>>3)+1, unsigned char);
Surprise = Alloc(MaxDiscrVal+1, float);
SomeNA = Alloc(MaxAtt+1, Boolean);
GLp = Alloc(101, CaseNo);
GEnv.Possible = Alloc(MaxDiscrVal+1, Boolean);
GEnv.Tested = Alloc(MaxAtt+1, int);
Caveat = Alloc(MaxAtt, CaveatRec);
ForEach(Att, 1, MaxAtt)
{
SomeNA[Att] = true;
Caveat[Att-1].Subset = Alloc((MaxDiscrVal>>3)+1, unsigned char);
}
/* Process successive entries */
while ( fscanf(Sf, "%d", &E) == 1 )
{
switch ( E )
{
case 0:
return;
case 1:
Case1();
break;
case 2:
Case2();
break;
case 3:
Case3();
break;
case 11:
Case11();
break;
case 12:
Case12();
break;
case 13:
Case13();
break;
case 21:
Case21();
break;
case 22:
Case22();
break;
default:
Error(BADSIFT, "entry", "");
}
}
}
/*************************************************************************/
/* */
/* Functions for each value of the switch variable */
/* */
/*************************************************************************/
void Case1()
/* ----- */
{
CaseNo i, Lp;
if ( fscanf(Sf, "%d\n", &ClassAtt) != 1 )
{
Error(BADSIFT, "1", "");
}
/* Remove cases with unknown value of new target and, if relevant,
those with values in excluded tails */
Lp = MaxCase;
for ( i = MaxCase ; i >= 0; i-- )
{
if ( Unknown(Case[i], ClassAtt) ||
( Continuous(ClassAtt) &&
( CVal(Case[i], ClassAtt) < LowTail[ClassAtt] ||
CVal(Case[i], ClassAtt) > HighTail[ClassAtt] ) ) )
{
Swap(i, Lp);
Lp--;
}
}
/* Initialise level etc */
GEnv.Level = -1;
GLp[0] = Lp;
}
void Case2()
/* ----- */
{
Attribute Att;
if ( fscanf(Sf, "%d\n", &Att) != 1 )
{
Error(BADSIFT, "2", "");
}
UseLogs[Att] = true;
}
void Case3()
/* ----- */
{
Attribute Att;
if ( fscanf(Sf, "%d", &Att) != 1 ||
fscanf(Sf, "%g %g\n", &LowTail[Att], &HighTail[Att]) != 2 )
{
Error(BADSIFT, "3", "");
}
}
void Case11()
/* ------ */
{
Attribute Att;
DiscrValue Br;
if ( fscanf(Sf, "%d %d %d\n", &GEnv.Level, &Att, &Br) != 3 )
{
Error(BADSIFT, "11", "");
}
Filter(Att, Br, 0, Nil);
}
void Case12()
/* ------ */
{
Attribute Att;
DiscrValue Br;
float Cut;
if ( fscanf(Sf, "%d %d %d %g\n", &GEnv.Level, &Att, &Br, &Cut) != 4 )
{
Error(BADSIFT, "12", "");
}
Filter(Att, Br, Cut, Nil);
}
void Case13()
/* ------ */
{
Attribute Att;
DiscrValue Br;
int Bytes, b, X;
if ( fscanf(Sf, "%d %d %d", &GEnv.Level, &Att, &Br) != 3 )
{
Error(BADSIFT, "13", "");
}
Bytes = (MaxAttVal[Att]>>3) + 1;
ForEach(b, 0, Bytes-1)
{
if ( fscanf(Sf, "%x", &X) != 1 )
{
Error(BADSIFT, "13+", "");
}
LeftSS[b] = X;
}
Filter(Att, Br, 0, LeftSS);
}
void Case21()
/* ------ */
{
CaseCount Cover, Anoms;
CaseNo i;
DiscrValue Expect, v;
float Frac;
Clust C=Nil;
if ( fscanf(Sf, "%d %g %d", &Cover, &Frac, &Expect) != 3 )
{
Error(BADSIFT, "21", "");
}
Anoms = rint(Cover * (1 - Frac));
ForEach(v, 1, MaxAttVal[ClassAtt])
{
Surprise[v] = 1;
}
while ( true )
{
if ( fscanf(Sf, "%d", &v) != 1 )
{
Error(BADSIFT, "21+", "");
}
if ( !v ) break;
if ( fscanf(Sf, "%g", &Surprise[v]) != 1 )
{
Error(BADSIFT, "21++", "");
}
}
ReadCaveats();
ForEach(i, 0, GLp[GEnv.Level+1])
{
v = XDVal(Case[i], ClassAtt);
if ( Surprise[v] < 1 && CheckCaveats(Case[i]) )
{
if ( ! C )
{
SetTestedAtts();
C = NewClust(Expect, 0.0, 0.0, Anoms, Cover);
}
FoundPossibleAnom(i, C, Surprise[v]);
}
}
}
void Case22()
/* ------ */
{
CaseCount Cover, Anoms;
CaseNo i;
Clust LowC=Nil, HighC=Nil;
float LowFrac, HighFrac, LowLim, HighLim, Mean, SD, Cv,
Z, LowLimZ, HighLimZ;
if ( fscanf(Sf, "%d %g %g %g %g %g %g",
&Cover, &Mean, &SD, &LowFrac, &LowLim, &HighFrac, &HighLim)
!= 7 )
{
Error(BADSIFT, "22", "");
}
if ( UseLogs[ClassAtt] )
{
LowLimZ = fabs(log(LowLim) - Mean) / SD;
HighLimZ = fabs(log(HighLim) - Mean) / SD;
}
else
{
LowLimZ = fabs(LowLim - Mean) / SD;
HighLimZ = fabs(HighLim - Mean) / SD;
}
ReadCaveats();
ForEach(i, 0, GLp[GEnv.Level+1])
{
Cv = CVal(Case[i], ClassAtt);
if ( UseLogs[ClassAtt] ) Cv = ( Cv > 0 ? log(Cv) : -1E38 );
Z = fabs(Mean - Cv) / SD;
if ( LowFrac > 0 && Cv < Mean &&
Z - LowLimZ >= MINABNORM - MAXNORM )
{
if ( CheckCaveats(Case[i]) )
{
if ( ! LowC )
{
SetTestedAtts();
Anoms = rint(Cover * (1 - LowFrac));
LowC = NewClust(Mean, SD, LowLim, Anoms, Cover);
}
FoundPossibleAnom(i, LowC, 1 / (Z * Z));
}
}
if ( HighFrac > 0 && Cv > Mean &&
Z - HighLimZ >= MINABNORM - MAXNORM )
{
if ( CheckCaveats(Case[i]) )
{
if ( ! HighC )
{
SetTestedAtts();
Anoms = rint(Cover * (1 - HighFrac));
HighC = NewClust(Mean, SD, HighLim, Anoms, Cover);
}
FoundPossibleAnom(i, HighC, 1 / (Z * Z));
}
}
}
}
/*************************************************************************/
/* */
/* Read any caveats on other attributes */
/* */
/*************************************************************************/
void ReadCaveats()
/* ----------- */
{
Attribute Att;
int Bytes, Byte, b;
NCaveat = 0;
while ( getc(Sf) == ' ' )
{
if ( fscanf(Sf, "%d", &Att) != 1 )
{
Error(BADSIFT, "caveat", "");
}
Caveat[NCaveat].Att = Att;
if ( Continuous(Att) )
{
if ( fscanf(Sf, "%g %g",
&Caveat[NCaveat].Low, &Caveat[NCaveat].High) != 2 )
{
Error(BADSIFT, "caveat", "");
}
}
else
{
Bytes = (MaxAttVal[Att]>>3) + 1;
ForEach(b, 0, Bytes-1)
{
if ( fscanf(Sf, "%x", &Byte) != 1 )
{
Error(BADSIFT, "caveat", "");
}
Caveat[NCaveat].Subset[b] = Byte;
}
}
NCaveat++;
}
}
/*************************************************************************/
/* */
/* Check that case satisfies all caveats */
/* */
/*************************************************************************/
Boolean CheckCaveats(Description Case)
/* ------------ */
{
Attribute Att;
int j;
ContValue Cv;
DiscrValue Dv;
for ( j = 0 ; j < NCaveat ; j++ )
{
Att = Caveat[j].Att;
if ( Continuous(Att) )
{
if ( ! Unknown(Case, Att) && ! NotApplic(Case, Att) &&
( (Cv = CVal(Case, Att)) < Caveat[j].Low ||
Cv > Caveat[j].High ) )
{
return false;
}
}
else
{
Dv = XDVal(Case, Att);
if ( In(Dv, Caveat[j].Subset) ) return false;
}
}
return true;
}
/*************************************************************************/
/* */
/* Found one -- see whether more interesting than current */
/* */
/*************************************************************************/
void FoundPossibleAnom(CaseNo i, Clust C, float Xv)
/* ----------------- */
{
Clust OldC;
OldC = OutClust(Case[i]);
if ( ! OldC ||
C->NCond < OldC->NCond ||
C->NCond == OldC->NCond && Xv < OutXVal(Case[i]) )
{
RecordOutlier(i, C, Xv);
}
}
/*************************************************************************/
/* */
/* Add test to the test stack and select relevant cases */
/* */
/*************************************************************************/
void Filter(Attribute Att, DiscrValue Br, ContValue Cut, Set Left)
/* ------ */
{
NoteTest(Att, Br, Cut, Left);
GLp[GEnv.Level+1] = Group(Att, Br, 0, GLp[GEnv.Level], Cut, Left) - 1;
}
/*************************************************************************/
/* */
/* Determine attributes used in all conditions */
/* */
/*************************************************************************/
void SetTestedAtts()
/* ------------- */
{
Attribute Att;
int i;
ForEach(Att, 1, MaxAtt)
{
GEnv.Tested[Att] = false;
}
ForEach(i, 0, GEnv.Level)
{
GEnv.Tested[GEnv.Test[i].Att] = true;
}
}
modelfiles.c 0000664 0000764 0000764 00000033024 11501534524 013261 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Routines for saving and reading sift files */
/* ------------------------------------------ */
/* */
/*************************************************************************/
/* Formats:
1 target att
2 use logs with att
3 set low/high tail
11
split on attribute value
12
threshold test
13
subset test
21 [ ]* 0 discrete cluster
22 low/high contin cluster
clusters may be followed by one or more caveats of the form
or
*/
#include "defns.i"
#include "extern.i"
int Entry;
char* Prop[]={"null",
"id",
"atts",
"att",
"sstat",
"elts",
"prec",
"label",
"def",
"minabnorm"
};
char PropName[20],
*PropVal=Nil,
*Unquoted;
int PropValSize=0;
#define PROPS 9
#define ERRORP 0
#define IDP 1
#define ATTSP 2
#define ATTP 3
#define SSTATP 4
#define ELTSP 5
#define PRECP 6
#define LABELP 7
#define DEFP 8
#define MINABNORMP 9
/*************************************************************************/
/* */
/* Check whether file is open. If it is not, open it and */
/* read/write header information and names */
/* */
/*************************************************************************/
void CheckFile(String Extension, Boolean Write)
/* --------- */
{
static char *LastExt="";
if ( ! Sf || strcmp(LastExt, Extension) )
{
LastExt = Extension;
if ( Sf )
{
fprintf(Sf, "\n");
fclose(Sf);
}
#ifdef INSPECT
ReadFilePrefix(Extension);
#else
if ( Write )
{
WriteFilePrefix(Extension);
}
else
{
ReadFilePrefix(Extension);
}
#endif
}
}
#ifndef INSPECT
/*************************************************************************/
/* */
/* Write information on system, parameters etc */
/* */
/*************************************************************************/
void WriteFilePrefix(String Extension)
/* --------------- */
{
time_t clock;
struct tm *now;
if ( ! (Sf = GetFile(Extension, "w")) )
{
Error(NOFILE, Fn, E_ForWrite);
}
clock = time(0);
now = localtime(&clock);
now->tm_mon++;
fprintf(Sf, "id=\"GritBot %s %d-%d%d-%d%d\"\n",
RELEASE,
now->tm_year + 1900,
now->tm_mon / 10, now->tm_mon % 10,
now->tm_mday / 10, now->tm_mday % 10);
SaveNames();
fprintf(Sf, "minabnorm=\"%g\"\n", MINABNORM);
}
void SaveCondition()
/* -------------- */
{
Attribute Att;
int CType, b, Bytes;
DiscrValue Br;
char SE[100];
if ( GEnv.Level < 0 ) return;
/* Save top condition */
Att = GEnv.Test[GEnv.Level].Att;
Br = GEnv.Test[GEnv.Level].Br;
/* Determine condition type */
CType = ( Br == 1 ? 11 :
Continuous(Att) || Ordered(Att) ? 12 :
Continuous(ClassAtt) && MaxAttVal[Att] > 3 ? 13 : 11 );
sprintf(SE, "%d %d %d %d", CType, GEnv.Level, Att, Br);
ExtendSiftEntry(SE);
/* Don't need to save anything else if this branch is 1 (N/A)
or if test is on two-valued discrete att */
if ( Br != 1 )
{
if ( Continuous(Att) || Ordered(Att) )
{
sprintf(SE, " %.8g", GEnv.Test[GEnv.Level].Cut);
ExtendSiftEntry(SE);
}
else
if ( Continuous(ClassAtt) && MaxAttVal[Att] > 3 )
{
/* Print subset of values */
Bytes = (MaxAttVal[Att]>>3) + 1;
ForEach(b, 0, Bytes-1)
{
sprintf(SE, " %x", GEnv.Test[GEnv.Level].Left[b]);
ExtendSiftEntry(SE);
}
}
}
ExtendSiftEntry("\n");
}
void SaveDiscrCluster(DiscrValue Expect, CaseCount Anoms, CaseCount Cases,
CaseCount *Freq)
/* ---------------- */
{
DiscrValue v;
float Xv;
char SE[100];
SaveCondition();
sprintf(SE, "21 %d %g %d",
Cases, (Cases - Anoms) / (Cases + 1E-3), Expect);
ExtendSiftEntry(SE);
ForEach(v, 1, MaxAttVal[ClassAtt])
{
if ( v == Expect ) continue;
Xv = XDScore(Freq[v], Cases, Anoms, Prior[ClassAtt][v]);
if ( Xv <= 1.0 / (MINABNORM * MINABNORM) )
{
sprintf(SE, " %d %.3f", v, Xv);
ExtendSiftEntry(SE);
}
}
ExtendSiftEntry(" 0");
}
void SaveContinCluster(float Mean, float SD, CaseCount Cases,
float LFrac, float LLim, float HFrac, float HLim)
/* ----------------- */
{
char SE[100];
SaveCondition();
sprintf(SE, "22 %d %g %g %g %.8g %g %.8g",
Cases, Mean, SD, LFrac, LLim, HFrac, HLim);
ExtendSiftEntry(SE);
}
/*************************************************************************/
/* */
/* Save attribute information */
/* */
/*************************************************************************/
void SaveNames()
/* --------- */
{
Attribute Att;
DiscrValue v;
int DN, Op;
fprintf(Sf, "atts=\"%d\"\n", MaxAtt);
ForEach(Att, 1, MaxAtt)
{
AsciiOut("att=", AttName[Att]);
fprintf(Sf, " sstat=\"%d\"", SpecialStatus[Att]);
if ( AttDef[Att] )
{
/* Dump definition */
fprintf(Sf, " def");
for ( DN = 0 ; ; DN++ )
{
Op = DefOp(AttDef[Att][DN]);
fprintf(Sf, "%c\"%d\"", ( DN ? ',' : '=' ), Op);
if ( Op == OP_ATT )
{
fprintf(Sf, ":\"%d\"",
(int) (long) DefSVal(AttDef[Att][DN]));
}
else
if ( Op == OP_STR )
{
AsciiOut(":", DefSVal(AttDef[Att][DN]));
}
else
{
fprintf(Sf, ":\"%g\"", DefNVal(AttDef[Att][DN]));
}
if ( Op == OP_END ) break;
}
}
if ( MaxAttVal[Att] > 0 )
{
AsciiOut(" elts=", AttValName[Att][2]); /* skip N/A */
ForEach(v, 3, MaxAttVal[Att])
{
AsciiOut(",", AttValName[Att][v]);
}
}
if ( Prec[Att] > 0 )
{
fprintf(Sf, " prec=\"%d\"", Prec[Att]);
}
fprintf(Sf, "\n");
}
if ( LabelAtt )
{
AsciiOut("label=", AttName[LabelAtt]);
fprintf(Sf, "\n");
}
}
/*************************************************************************/
/* */
/* Write ASCII string with prefix, escaping any quotes */
/* */
/*************************************************************************/
void AsciiOut(String Pre, String S)
/* -------- */
{
fprintf(Sf, "%s\"", Pre);
while ( *S )
{
if ( *S == '"' || *S == '\\' ) fputc('\\', Sf);
fputc(*S++, Sf);
}
fputc('"', Sf);
}
#endif
/*************************************************************************/
/* */
/* Read header information */
/* */
/*************************************************************************/
void ReadFilePrefix(String Extension)
/* -------------- */
{
Attribute Att=0;
DiscrValue v;
char *p, Dummy;
int Year, Month, Day, X, Elts, Op, DN, DefSize;
float A;
extern AttValue _UNK, _NA;
if ( ! (Sf = GetFile(Extension, "r")) ) Error(NOFILE, Fn, "");
while ( true )
{
switch ( ReadProp(&Dummy) )
{
case ERRORP:
Error(BADSIFT, PropName, "");
return;
case IDP:
/* Recover year run and set base date for timestamps */
if ( sscanf(PropVal + strlen(PropVal) - 11,
"%d-%d-%d\"", &Year, &Month, &Day) == 3 )
{
SetTSBase(Year);
}
break;
case ATTSP:
Unquoted = RemoveQuotes(PropVal);
if ( sscanf(Unquoted, "%d", &MaxAtt) != 1 )
{
Error(BADSIFT, "atts", "");
}
AttName = Alloc(MaxAtt+1, String);
SpecialStatus = AllocZero(MaxAtt+1, char);
AttDef = AllocZero(MaxAtt+1, Definition);
AttValName = Alloc(MaxAtt+1, String *);
MaxAttVal = AllocZero(MaxAtt+1, int);
Prec = Alloc(MaxAtt+1, unsigned char);
UseLogs = AllocZero(MaxAtt+1, Boolean);
LowTail = Alloc(MaxAtt+1, float);
HighTail = Alloc(MaxAtt+1, float);
Att = 0;
break;
case ATTP:
Att++;
if ( Att > MaxAtt )
{
Error(BADSIFT, "att", "");
}
Unquoted = RemoveQuotes(PropVal);
AttName[Att] = strdup(Unquoted);
LowTail[Att] = -1E38;
HighTail[Att] = 1E38;
break;
case SSTATP:
Unquoted = RemoveQuotes(PropVal);
if ( sscanf(Unquoted, "%d", &X) != 1 )
{
Error(BADSIFT, "sstat", "");
}
SpecialStatus[Att] = X;
break;
case ELTSP:
Elts = 100;
AttValName[Att] = Alloc(Elts, String);
MaxAttVal[Att] = 1;
AttValName[Att][1] = strdup("N/A");
for ( p = PropVal ; *p ; )
{
p = RemoveQuotes(p);
v = ++MaxAttVal[Att];
if ( v+2 >= Elts )
{
Elts += 100;
Realloc(AttValName[Att], Elts, String);
}
AttValName[Att][v] = strdup(p);
for ( p += strlen(p) ; *p != '"' ; p++ )
;
p++;
if ( *p == ',' ) p++;
}
break;
case PRECP:
Unquoted = RemoveQuotes(PropVal);
if ( sscanf(Unquoted, "%d", &X) != 1 )
{
Error(BADSIFT, "prec", "");
}
Prec[Att] = X;
break;
case LABELP:
Unquoted = RemoveQuotes(PropVal);
LabelAtt = Which(Unquoted, AttName, 1, MaxAtt);
break;
case DEFP:
/* Make sure _UNK and _NA are set */
_UNK._discr_val = UNKNOWN;
_NA._discr_val = NA;
/* Allocate initial space for definition */
AttDef[Att] = AllocZero(DefSize = 100, DefElt);
DN = 0;
/* Read definition operators */
for ( p = PropVal ; *p ; )
{
/* Check that space is available */
if ( DN >= DefSize )
{
DefSize += 100;
Realloc(AttDef[Att], DefSize, DefElt);
}
/* Read opcode */
p = RemoveQuotes(p);
if ( sscanf(p, "%d", &Op) != 1 )
{
Error(BADSIFT, "def", "");
}
DefOp(AttDef[Att][DN]) = Op;
/* Move to start of operand */
for ( p += strlen(p) ; *p != '"' ; p++ )
;
p++;
if ( *p != ':' )
{
Error(BADSIFT, "def", "");
}
p++;
/* Read operand -- depends on opcode */
p = RemoveQuotes(p);
if ( Op == OP_ATT )
{
if ( sscanf(p, "%d", &X) != 1 )
{
Error(BADSIFT, "def", "");
}
DefSVal(AttDef[Att][DN]) = (void *) X;
}
else
if ( Op == OP_STR )
{
DefSVal(AttDef[Att][DN]) = strdup(p);
}
else
{
if ( sscanf(p, "%g", &A) != 1 )
{
Error(BADSIFT, "def", "");
}
DefNVal(AttDef[Att][DN]) = A;
}
/* Get ready for next entry */
DN++;
for ( p += strlen(p) ; *p != '"' ; p++ )
;
p++;
if ( *p == ',' ) p++;
}
break;
case MINABNORMP:
Unquoted = RemoveQuotes(PropVal);
if ( sscanf(Unquoted, "%g", &MINABNORM) != 1 )
{
Error(BADSIFT, "minabnorm", "");
}
return;
}
}
}
/*************************************************************************/
/* */
/* ASCII reading utilities */
/* */
/*************************************************************************/
int ReadProp(char *Delim)
/* -------- */
{
int c, i;
char *p;
Boolean Quote=false;
for ( p = PropName ; (c = fgetc(Sf)) != '=' ; )
{
if ( p - PropName >= 19 || c == EOF )
{
Error(BADSIFT, "EOF", "");
PropName[0] = PropVal[0] = *Delim = '\00';
return 0;
}
*p++ = c;
}
*p = '\00';
for ( p = PropVal ; ((c = fgetc(Sf)) != ' ' && c != '\n') || Quote ; )
{
if ( c == EOF )
{
Error(BADSIFT, "EOF", "");
PropName[0] = PropVal[0] = '\00';
return 0;
}
if ( (i = p - PropVal) >= PropValSize )
{
PropValSize += 10000;
Realloc(PropVal, PropValSize + 3, char);
p = PropVal + i;
}
*p++ = c;
if ( c == '\\' )
{
*p++ = fgetc(Sf);
}
else
if ( c == '"' )
{
Quote = ! Quote;
}
}
*p = '\00';
*Delim = c;
return Which(PropName, Prop, 1, PROPS);
}
String RemoveQuotes(String S)
/* ------------ */
{
char *p, *Start;
p = Start = S;
for ( S++ ; *S != '"' ; S++ )
{
if ( *S == '\\' ) S++;
*p++ = *S;
*S = '-';
}
*p = '\00';
return Start;
}
/*************************************************************************/
/* */
/* Add more text to a sift entry */
/* */
/*************************************************************************/
void ExtendSiftEntry(String S)
/* --------------- */
{
int Len;
/* Make sure there is enough room */
if ( (Len = strlen(S)) >= GEnv.SiftSpace - GEnv.SiftSize )
{
GEnv.SiftSpace += 1000;
if ( GEnv.SiftEntry )
{
Realloc(GEnv.SiftEntry, GEnv.SiftSpace, char);
}
else
{
GEnv.SiftEntry = Alloc(GEnv.SiftSpace, char);
}
}
strcpy(GEnv.SiftEntry + GEnv.SiftSize, S);
GEnv.SiftSize += Len;
}
outlier.c 0000664 0000764 0000764 00000021547 11501534524 012630 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Routines for recording, reporting, saving and recovering */
/* possible outliers */
/* -------------------------------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
/*************************************************************************/
/* */
/* Record outlier information for a case in cluster C */
/* */
/*************************************************************************/
void RecordOutlier(CaseNo i, Clust C, float XVal)
/* ------------- */
{
OutXVal(Case[i]) = XVal;
OutClust(Case[i]) = C;
}
/*************************************************************************/
/* */
/* Print outlier reports */
/* */
/*************************************************************************/
void ReportOutliers()
/* -------------- */
{
CaseNo i, j, *Show, NShow=0, Stop=0;
Boolean FirstFromTest=true;
FILE *Lf;
Show = Alloc(MaxCase+1, CaseNo);
NotifyStage(REPORTING);
Progress(-1);
/* Isolate outlier items */
if ( LIST && ! (Lf = GetFile(".list", "w")) )
{
Error(NOFILE, "", " for writing");
}
ForEach(i, 0, MaxCase)
{
if ( OutClust(Case[i]) )
{
Show[NShow++] = i;
if ( LIST )
{
if ( i > LastDataCase && FirstFromTest )
{
fprintf(Lf, "\n");
FirstFromTest = false;
}
fprintf(Lf, "%d\n",
( i <= LastDataCase ? i+1 : i - LastDataCase ));
}
}
}
if ( LIST ) fclose(Lf);
/* Print outliers in descending order of confidence. If MAXOUT
is set, show only the first MAXOUT */
fprintf(Of, F_PossAnomalies(NShow));
if ( MAXOUT > 0 && NShow > MAXOUT )
{
Stop = NShow - MAXOUT;
}
while ( NShow > Stop )
{
j = 0;
for ( i = 1 ; i < NShow ; i++ )
{
if ( OutXVal(Case[Show[i]]) < OutXVal(Case[Show[j]]) ||
OutXVal(Case[Show[i]]) == OutXVal(Case[Show[j]]) &&
Show[i] < Show[j] )
{
j = i;
}
}
PrintOutlier(Show[j], OutClust(Case[Show[j]]), OutXVal(Case[Show[j]]));
Show[j] = Show[--NShow];
}
Free(Show);
}
/*************************************************************************/
/* */
/* Print the anomalous value and its context, then the */
/* conditions that define the subset */
/* */
/*************************************************************************/
void PrintOutlier(CaseNo i, Clust C, ContValue XVal)
/* ------------ */
{
char CVS1[20], CVS2[20];
int d;
Attribute Att;
float Mean;
double Base;
/* Identify the case */
if ( i > LastDataCase )
{
fprintf(Of, F_NoTestCase(i - LastDataCase));
}
else
if ( LastDataCase < MaxCase )
{
fprintf(Of, F_NoDataCase(i+1));
}
else
{
fprintf(Of, F_NoCase(i+1));
}
if ( LabelAtt && SVal(Case[i], LabelAtt) )
{
fprintf(Of, F_LabelCase(CaseLabel(i)));
}
fprintf(Of, " [%.3f]\n", XVal);
/* Show the primary attribute whose value is suspect */
fprintf(Of, "\t");
PrintAttVal(Case[i], C->Att);
fprintf(Of, F_Cases(C->GpSize));
if ( Continuous(C->Att) )
{
Mean = ( UseLogs[C->Att] ? exp(C->Expect) : C->Expect );
Base = pow(10.0, Prec[C->Att]);
CValToStr(rint(Mean * Base) / Base, C->Att, CVS1);
CValToStr(C->Limit, C->Att, CVS2);
fprintf(Of, F_CvGroup(CVS1,
( C->GpSize < 100 ? 0 : C->GpSize < 1000 ? 1 : 2 ),
C->Frac * 100,
( Mean < CVal(Case[i], C->Att) ? "<=" : ">=" ),
CVS2));
}
else
{
fprintf(Of, F_DvGroup(
( C->GpSize < 100 ? 0 : C->GpSize < 1000 ? 1 : 2 ),
C->Frac * 100,
AttValName[C->Att][(int) C->Expect]));
}
/* Show any conditioning tests */
ForEach(d, 0, C->NCond-1)
{
Att = C->Cond[d].Att;
if ( Continuous(Att) )
{
PrintContinCond(Att, C->Cond[d].Low, C->Cond[d].High, i);
}
else
if ( Ordered(Att) )
{
PrintOrderedCond(Att, (int) C->Cond[d].Low, (int) C->Cond[d].High,
i);
}
else
if ( Continuous(C->Att) && MaxAttVal[Att] > 3 )
{
PrintSubsetCond(Att, C->Cond[d].Values, i);
}
else
{
PrintValCond(Att, (int) C->Cond[d].Low);
}
}
}
/*************************************************************************/
/* */
/* Print an attribute value */
/* */
/*************************************************************************/
void PrintAttVal(Description Case, Attribute Att)
/* ----------- */
{
char CVS[20];
fprintf(Of, "%s = ", AttName[Att]);
if ( Unknown(Case, Att) )
{
fprintf(Of, "?");
}
if ( NotApplic(Case, Att) )
{
fprintf(Of, "N/A");
}
else
if ( Continuous(Att) )
{
CValToStr(CVal(Case, Att), Att, CVS);
fprintf(Of, "%s", CVS);
}
else
{
fprintf(Of, "%s", AttValName[Att][XDVal(Case, Att)]);
}
}
/*************************************************************************/
/* */
/* Print a condition defining a subset (cluster). */
/* Different functions are called for different formats etc. */
/* */
/*************************************************************************/
void PrintContinCond(Attribute Att, ContValue Lo, ContValue Hi, CaseNo N)
/* --------------- */
{
char CVS1[20], CVS2[20];
fprintf(Of, "\t %s ", AttName[Att]);
if ( Lo > Hi )
{
fprintf(Of, "= N/A\n");
}
else
{
if ( Lo <= -MARKER )
{
CValToStr(Hi, Att, CVS1);
fprintf(Of, "<= %s", CVS1);
}
else
if ( Hi >= MARKER )
{
CValToStr(Lo, Att, CVS1);
fprintf(Of, "> %s", CVS1);
}
else
{
CValToStr(Lo, Att, CVS1);
CValToStr(Hi, Att, CVS2);
fprintf(Of, "> %s " T_and " <= %s", CVS1, CVS2);
}
CValToStr(CVal(Case[N], Att), Att, CVS1);
fprintf(Of, " [%s]\n", CVS1);
}
}
void PrintOrderedCond(Attribute Att, DiscrValue Lo, DiscrValue Hi, CaseNo N)
/* ---------------- */
{
fprintf(Of, "\t %s ", AttName[Att]);
if ( Lo == 1 && Hi == 1 )
{
fprintf(Of, "= N/A\n");
}
else
if ( Lo == Hi )
{
fprintf(Of, "= %s\n", AttValName[Att][Lo]);
}
else
{
fprintf(Of, T_in " %s .. %s [%s]\n",
AttValName[Att][Lo], AttValName[Att][Hi],
AttValName[Att][DVal(Case[N], Att)]);
}
}
void PrintSubsetCond(Attribute Att, Set Values, CaseNo N)
/* --------------- */
{
DiscrValue v, Last;
int Elts=0, Col, Entry;
Boolean First=true;
if ( In(1, Values) )
{
fprintf(Of, "\t %s = N/A\n", AttName[Att]);
return;
}
/* Special case for singleton */
ForEach(v, 2, MaxAttVal[Att])
{
if ( In(v, Values) )
{
Elts++;
Last = v;
}
}
if ( Elts == 1 )
{
fprintf(Of, "\t %s = %s\n",
AttName[Att], AttValName[Att][Last]);
return;
}
/* Print the subset, breaking lines appropriately */
fprintf(Of, "\t %s " T_in " {", AttName[Att]);
Col = strlen(AttName[Att]) + 9;
ForEach(v, 2, MaxAttVal[Att])
{
if ( In(v, Values) )
{
if ( First )
{
First = false;
}
else
{
fprintf(Of, ", ");
Col += 2;
}
Entry = strlen(AttValName[Att][v]);
if ( Col + Entry >= 70 )
{
Col = strlen(AttName[Att]) + 9;
fprintf(Of, "\n\t%*s", Col, "");
}
fprintf(Of, "%s", AttValName[Att][v]);
Col += Entry;
}
}
fprintf(Of, "}");
Col++;
/* Now print the actual value */
v = DVal(Case[N], Att);
if ( Col + strlen(AttValName[Att][v]) + 3 > 72 )
{
fprintf(Of, "\n\t ");
}
fprintf(Of, " [%s]\n", AttValName[Att][v]);
}
void PrintValCond(Attribute Att, DiscrValue v)
/* ------------ */
{
fprintf(Of, "\t %s = %s\n",
AttName[Att], AttValName[Att][v]);
}
sort.c 0000664 0000764 0000764 00000006211 11501534524 012123 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Sorting utilities */
/* ----------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
#define SwapPair(a,b) {Xab=Pair[a]; Pair[a]=Pair[b]; Pair[b]=Xab;}
SortPair *Pair=Nil;
/*************************************************************************/
/* */
/* Sort items from Fp to Lp on attribute Att. */
/* To maximise cache hits, values are copied into Pair and */
/* the results copied back to Case. */
/* */
/*************************************************************************/
void Quicksort(CaseNo Fp, CaseNo Lp, Attribute Att)
/* --------- */
{
CaseNo i;
ForEach(i, Fp, Lp)
{
Pair[i].C = CVal(Case[i], Att);
Pair[i].D = Case[i];
}
Cachesort(Fp, Lp);
ForEach(i, Fp, Lp)
{
Case[i] = Pair[i].D;
}
}
/*************************************************************************/
/* */
/* Sort elements Fp to Lp of Pair */
/* */
/*************************************************************************/
void Cachesort(CaseNo Fp, CaseNo Lp)
/* --------- */
{
CaseNo i, Middle, High;
ContValue Thresh, Val;
SortPair Xab;
while ( Fp < Lp )
{
Thresh = Pair[(Fp+Lp) / 2].C;
/* Divide elements into three groups:
Fp .. Middle-1: values < Thresh
Middle .. High: values = Thresh
High+1 .. Lp: values > Thresh */
for ( Middle = Fp ; Pair[Middle].C < Thresh ; Middle++ )
;
for ( High = Lp ; Pair[High].C > Thresh ; High-- )
;
for ( i = Middle ; i <= High ; )
{
if ( (Val = Pair[i].C) < Thresh )
{
SwapPair(Middle, i);
Middle++;
i++;
}
else
if ( Val > Thresh )
{
SwapPair(High, i);
High--;
}
else
{
i++;
}
}
/* Sort the first group */
Cachesort(Fp, Middle-1);
/* Continue with the last group */
Fp = High+1;
}
}
text.i 0000664 0000764 0000764 00000015040 11501534524 012126 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Text strings for UTF-8 internationalization */
/* ------------------------------------------- */
/* */
/*************************************************************************/
/* General stuff */
#ifdef UTF8
#define CharWidth(S) UTF8CharWidth(S)
#else
#define CharWidth(S) (int) strlen(S)
#endif
/* Strings etc */
#define T_GritBot "GritBot"
#define F_Release(n) "Release " n
#define T_Options "Options"
#define F_Application "\tApplication `%s'\n"
#define F_Filtering "\tFiltering level %g%%\n"
#define F_MaxConds "\tMaxium %d conditions in description\n"
#define F_MinSubset "\tMinimum %d cases in subset\n"
#define F_MaxOut "\tShow up to %d possible anomalies\n"
#define F_NoSift "\tDo not save analysis in .sift file\n"
#define F_ListAnoms "\tSave case numbers of possible anomalies\n"
#define F_UnrecogOpt "\n ** Unrecognised option %s"\
"\n ** Summary of options for GritBot:\n"
#define F_OptList "\t-f \tapplication filestem\n"\
"\t-l \tfiltering level\n"\
"\t-c \tmaximum conditions in"\
" description\n"\
"\t-n \tlimit number of possible"\
" anomalies reported\n"\
"\t-s\t\tdo not save .sift file\n"\
"\t-r\t\trecord case numbers of"\
" possible anomalies\n"\
"\t-h\t\tprint this message\n"
#define F_ReadData(c,a,f) "\nRead %d cases (%d attributes) from"\
" %s.data\n", c, a, f
#define F_ReadTest(c,f) "Read %d cases from %s.test\n", c, f
#define F_AttChecked "\nAttributes checked:\n"
#define F_AttNotChecked "\nAttributes not checked:\n"
#define F_Time(s) "\n\nTime: %.1f secs\n", s
#define F_WhileCheck "\n while checking %s:\n"
#define F_ExcludeMissing(a) ( (a) > 1 ?\
"\texcluding %d missing values\n" :\
"\texcluding %d missing value\n" ), a
#define F_ExcludeNA(a) ( (a) > 1 ?\
"\texcluding %d N/A values\n" :\
"\texcluding %d N/A value\n" ), a
#define F_TooManyIdentical "\ttoo many identical values -- excluded\n"
#define F_LowTail(c,t) "\texcluding low tail (%d cases below %s)\n",\
c, t
#define F_HighTail(c,t) "\texcluding high tail (%d cases above %s)\n",\
c, t
#define F_WarnDemo "\n\t** This demonstration version cannot"\
" process **\n"\
"\t** more than %d training or test cases."\
" **\n"\
#define F_PossAnomalies(a) ( (a) != 1 ?\
"\n%d possible anomalies identified\n" :\
"\n%d possible anomaly identified\n" ), a
#define F_NoTestCase(c) "\ntest case %d:", c
#define F_NoDataCase(c) "\ndata case %d:", c
#define F_NoCase(c) "\ncase %d:", c
#define F_LabelCase(l) " (label %s)", l
#define F_Cases(c) " (%d cases, ", c
#define F_CvGroup(m,d,p,r,v) "mean %s, %.*f%% %s %s)\n", m, d, p, r, v
#define F_DvGroup(d,p,v) "%.*f%% `%s')\n", d, p, v
#define T_and "and"
#define T_in "in" /* element of set */
#define T_ReadTrain "Reading training data"
#define T_ReadTest "Reading test data"
#define T_Prelim "Preliminaries"
#define T_Checking "Checking"
#define T_Reporting "Reporting anomalies"
#define T_CleaningUp "Cleaning up"
#define F_Preliminaries "Preliminaries for %-21.21s\n"
#define F_Checking(a,x,y,c) "Checking %-21.21s %s%s (%d cases"\
" checked)\n", a, x, y, c
#define F_Line(l,f) "*** line %d of `%s': ", l, f
#define E_NOFILE(f,e) "cannot open file %s%s\n", f, e
#define E_ForWrite " for writing"
#define E_BADATTNAME "`:' or `:=' expected after attribute name"\
" `%s'\n"
#define E_UNKNOWNATT "unknown attribute name `%s'\n"
#define E_EOFINATT "unexpected eof while reading attribute `%s'\n"
#define E_SINGLEATTVAL(a,v) "attribute `%s' has only one value `%s'\n",\
a, v
#define E_DUPATTNAME "multiple attributes with name `%s'\n"
#define E_BADATTVAL(v,a) "bad value of `%s' for attribute `%s'\n", v, a
#define E_BADNUMBER(a) "value of `%s' changed to `?'\n", a
#define E_BADCLASS "bad class value `%s'l\n"
#define E_NOMEM "unable to allocate sufficient memory\n"
#define E_TOOMANYVALS(a,n) "too many values for attribute `%s'"\
" (max %d)\n", a, n
#define E_BADDISCRETE "bad number of discrete values for attribute"\
" `%s'\n"
#define E_LONGNAME "overlength name: check data file formats\n"
#define E_HITEOF "unexpected end of file\n"
#define E_MISSNAME "missing name or value before `%s'\n"
#define E_BADTSTMP(d,a) "bad timestamp `%s' for attribute `%s'\n", d, a
#define E_BADDATE(d,a) "bad date `%s' for attribute `%s'\n", d, a
#define E_BADTIME(d,a) "bad time `%s' for attribute `%s'\n", d, a
#define E_BADDEF1(a,s,x) "in definition of attribute `%s':\n"\
"\tat `%.12s': expect %s\n", a, s, x
#define E_BADDEF2(a,s,x) "in definition of attribute `%s':\n"\
"\t`%s': %s\n", a, s, x
#define E_SAMEATT(a,b) "attribute `%s' is identical to attribute"\
" `%s'\n", a, b
#define E_BADDEF3 "cannot define target attribute `%s'\n"
#define E_SIFT "sift file corrupted (entry \"%s\")\n"
#define T_ErrorLimit "\nError limit exceeded\n"
#define F_CkOptList "\t-f \tapplication filestem\n"\
"\t-n \tlimit number of possible"\
" anomalies reported\n"\
"\t-r\t\trecord case numbers of"\
" possible anomalies\n"\
"\t-h\t\tprint this message\n"
#define F_ReadSift "\nRead saved analysis from %s.sift\n"
#define F_ReadCases(c,a,f) "Read %d cases (%d attributes) from"\
" %s.cases\n", c, a, f
update.c 0000664 0000764 0000764 00000006611 11501534524 012422 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Routines that provide information on progress */
/* --------------------------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
int Stage=0; /* Current stage number */
FILE *Uf=0; /* File to which update info written */
/*************************************************************************/
/* */
/* There are five stages (see messages in Progress() below) */
/* Record stage and open update file if necessary */
/* */
/*************************************************************************/
void NotifyStage(int S)
/* ----------- */
{
Stage = S;
if ( S == 1 )
{
if ( ! (Uf = GetFile(".tmp", "w")) ) Error(NOFILE, "", " for writing");
}
}
/*************************************************************************/
/* */
/* Print progress message. This routine is called in two ways: */
/* * negative Delta = measure of total effort required for stage */
/* * positive Delta = increment since last call */
/* */
/*************************************************************************/
void Progress(int Delta)
/* -------- */
{
static int Att, Current=0, Twentieth=0, LastStage=0;
int p;
static char *Message[]={ "",
T_ReadTrain,
T_ReadTest,
T_Prelim,
T_Checking,
T_Reporting,
T_CleaningUp },
*Done=">>>>>>>>>>>>>>>>>>>>",
*ToDo="....................";
if ( ! Uf ) return;
if ( Delta < 0)
{
Att = -Delta;
Current = 0;
Twentieth = -1;
if ( Stage == PRELIM )
{
fprintf(Uf, F_Preliminaries, AttName[Att]);
fflush(Uf);
}
}
else
{
Current = Min(MaxCase+1, Current + Delta);
}
if ( Stage != PRELIM &&
( (p = rint((20.0 * Current) / (MaxCase+1.01))) != Twentieth ||
Stage != LastStage ) )
{
LastStage = Stage;
Twentieth = p;
if ( Stage == CHECKING )
{
fprintf(Uf, F_Checking(AttName[Att],
Done + (20 - Twentieth), ToDo + Twentieth,
Current));
}
else
{
fprintf(Uf, "%s\n", Message[Stage]);
}
fflush(Uf);
}
}
utility.c 0000664 0000764 0000764 00000052563 11501534524 012652 0 ustar quinlan quinlan /*************************************************************************/
/* */
/* Copyright 2010 Rulequest Research Pty Ltd. */
/* */
/* This file is part of GritBot GPL Edition, a single-threaded version */
/* of GritBot release 2.01. */
/* */
/* GritBot GPL Edition is free software: you can redistribute it */
/* and/or modify it under the terms of the GNU General Public License */
/* as published by the Free Software Foundation, either version 3 of */
/* the License, or (at your option) any later version. */
/* */
/* GritBot GPL Edition is distributed in the hope that it will be */
/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* (gpl.txt) along with GritBot GPL Edition. If not, see */
/* */
/* . */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* Print header for all programs */
/* ----------------------------- */
/* */
/*************************************************************************/
#include "defns.i"
#include "extern.i"
#include
void PrintHeader(String Title)
/* ----------- */
{
char TitleLine[80];
time_t clock;
int Underline;
clock = time(0);
sprintf(TitleLine, "%s%s [%s]", T_GritBot, Title, F_Release(RELEASE));
fprintf(Of, "\n%s \t%s", TitleLine, ctime(&clock));
Underline = CharWidth(TitleLine);
while ( Underline-- ) putc('-', Of);
putc('\n', Of);
}
/*************************************************************************/
/* */
/* This is a specialised form of the getopt utility. */
/* */
/*************************************************************************/
String OptArg, Option;
char ProcessOption(int Argc, char *Argv[], char *Options)
/* ------------- */
{
int i;
static int OptNo=1;
if ( OptNo >= Argc ) return '\00';
if ( *(Option = Argv[OptNo++]) != '-' ) return '?';
for ( i = 0 ; Options[i] ; i++ )
{
if ( Options[i] == Option[1] )
{
OptArg = ( Options[i+1] != '+' ? Nil :
Option[2] ? Option+2 :
OptNo < Argc ? Argv[OptNo++] : "0" );
return Option[1];
}
}
return '?';
}
/*************************************************************************/
/* */
/* Protected memory allocation routines */
/* */
/*************************************************************************/
void *Pmalloc(size_t Bytes)
/* ------- */
{
void *p=Nil;
if ( ! Bytes || (p = (void *) malloc(Bytes)) )
{
return p;
}
Error(NOMEM, "", "");
}
void *Prealloc(void *Present, size_t Bytes)
/* -------- */
{
void *p=Nil;
if ( ! Bytes ) return Nil;
if ( ! Present ) return Pmalloc(Bytes);
if ( (p = (void *) realloc(Present, Bytes)) )
{
return p;
}
Error(NOMEM, "", "");
}
void *Pcalloc(size_t Number, unsigned int Size)
/* ------- */
{
void *p=Nil;
if ( ! Number || (p = (void *) calloc(Number, Size)) )
{
return p;
}
Error(NOMEM, "", "");
}
void FreeVector(void **V, int First, int Last)
/* ---------- */
{
if ( V )
{
while ( First <= Last )
{
FreeUnlessNil(V[First]);
First++;
}
Free(V);
}
}
/*************************************************************************/
/* */
/* Special memory allocation routines for case memory */
/* */
/*************************************************************************/
typedef struct _datablockrec *DataBlock;
typedef struct _datablockrec
{
Description Head; /* first address */
int Allocated; /* number of cases in this block */
DataBlock Prev; /* previous data block */
}
DataBlockRec;
DataBlock DataMem=Nil;
int DataBlockSize=0;
Description NewCase()
/* ------- */
{
DataBlock Prev;
if ( ! DataMem || DataMem->Allocated == DataBlockSize )
{
DataBlockSize = Min(8192, 262144 / (MaxAtt+3) + 1);
Prev = DataMem;
DataMem = AllocZero(1, DataBlockRec);
DataMem->Head = Alloc(DataBlockSize * (MaxAtt+3), AttValue);
DataMem->Prev = Prev;
}
return DataMem->Head + (DataMem->Allocated++) * (MaxAtt+3);
}
void MemTrim()
/* ------- */
{
Realloc(DataMem->Head, DataMem->Allocated * (MaxAtt+3), AttValue);
}
void FreeCases()
/* --------- */
{
DataBlock Prev;
while ( DataMem )
{
Prev = DataMem->Prev;
Free(DataMem->Head);
Free(DataMem);
DataMem = Prev;
}
}
void FreeLastCase(Description Case)
/* ------------ */
{
Attribute Att;
ForEach(Att, 1, MaxAtt)
{
if ( Exclude(Att) ) Free(SVal(Case,Att));
}
DataMem->Allocated--;
}
/*************************************************************************/
/* */
/* Generate uniform random numbers */
/* */
/*************************************************************************/
#define Modify(F,S) if ( (F -= S) < 0 ) F += 1.0
int KRFp=0, KRSp=0;
double KRandom()
/* ------- */
{
static double URD[55];
double V1, V2;
int i, j;
/* Initialisation */
if ( KRFp == KRSp )
{
KRFp = 0;
KRSp = 31;
V1 = 1.0;
V2 = 0.314159285;
ForEach(i, 1, 55)
{
URD[ j = (i * 21) % 55 ] = V1;
V1 = V2 - V1;
if ( V1 < 0 ) V1 += 1.0;
V2 = URD[j];
}
ForEach(j, 0, 5)
{
ForEach(i, 0, 54)
{
Modify(URD[i], URD[(i+30) % 55]);
}
}
}
KRFp = (KRFp + 1) % 55;
KRSp = (KRSp + 1) % 55;
Modify(URD[KRFp], URD[KRSp]);
return URD[KRFp];
}
void ResetKR(int KRInit)
/* ------- */
{
KRFp = KRSp = 0;
KRInit += 1000;
while ( KRInit-- )
{
KRandom();
}
}
/*************************************************************************/
/* */
/* Error messages */
/* */
/*************************************************************************/
void Error(int ErrNo, String S1, String S2)
/* ----- */
{
Boolean Quit=false;
if ( ! Of ) return;
if ( ! ErrMsgs )
{
fprintf(Of, "\n");
}
if ( ErrNo == NOFILE || ErrNo == NOMEM || ErrNo == BADSIFT )
{
fprintf(Of, "*** ");
}
else
{
fprintf(Of, F_Line(LineNo, Fn));
}
switch ( ErrNo )
{
case NOFILE:
fprintf(Of, E_NOFILE(Fn, S2));
Quit = true;
break;
case BADATTNAME:
fprintf(Of, E_BADATTNAME, S1);
break;
case UNKNOWNATT:
fprintf(Of, E_UNKNOWNATT, S1);
break;
case EOFINATT:
fprintf(Of, E_EOFINATT, S1);
break;
case SINGLEATTVAL:
fprintf(Of, E_SINGLEATTVAL(S1, S2));
break;
case DUPATTNAME:
fprintf(Of, E_DUPATTNAME, S1);
break;
case BADATTVAL:
fprintf(Of, E_BADATTVAL(S2, S1));
break;
case BADNUMBER:
fprintf(Of, E_BADNUMBER(S1));
break;
case BADCLASS:
fprintf(Of, E_BADCLASS, S2);
break;
case NOMEM:
fprintf(Of, E_NOMEM);
Quit = true;
break;
case TOOMANYVALS:
fprintf(Of, E_TOOMANYVALS(S1, (int) S2));
break;
case BADDISCRETE:
fprintf(Of, E_BADDISCRETE, S1);
break;
case LONGNAME:
fprintf(Of, E_LONGNAME);
Quit = true;
break;
case HITEOF:
fprintf(Of, E_HITEOF);
break;
case MISSNAME:
fprintf(Of, E_MISSNAME, S2);
break;
case BADTSTMP:
fprintf(Of, E_BADTSTMP(S2, S1));
break;
case BADDATE:
fprintf(Of, E_BADDATE(S2, S1));
break;
case BADTIME:
fprintf(Of, E_BADTIME(S2, S1));
break;
case BADDEF1:
fprintf(Of, E_BADDEF1(AttName[MaxAtt], S1, S2));
break;
case BADDEF2:
fprintf(Of, E_BADDEF2(AttName[MaxAtt], S1, S2));
break;
case SAMEATT:
fprintf(Of, E_SAMEATT(AttName[MaxAtt], S1));
break;
case BADDEF3:
fprintf(Of, E_BADDEF3, AttName[MaxAtt]);
break;
case BADSIFT:
fprintf(Of, E_SIFT, S1);
Quit = true;
break;
}
if ( ++ErrMsgs > 10 )
{
fprintf(Of, T_ErrorLimit);
MaxCase--;
Quit = true;
}
if ( Quit )
{
Goodbye(1);
}
}
/*************************************************************************/
/* */
/* Generate the label for a case */
/* */
/*************************************************************************/
char LabelBuffer[1000];
String CaseLabel(CaseNo N)
/* --------- */
{
String p;
if ( LabelAtt && (p = SVal(Case[N], LabelAtt)) )
;
else
{
sprintf(LabelBuffer, "#%d", N+1);
p = LabelBuffer;
}
return p;
}
/*************************************************************************/
/* */
/* Open file with given extension for read/write */
/* */
/*************************************************************************/
FILE *GetFile(String Extension, String RW)
/* -------- */
{
strcpy(Fn, FileStem);
strcat(Fn, Extension);
return fopen(Fn, RW);
}
/*************************************************************************/
/* */
/* Determine total elapsed time so far. */
/* */
/*************************************************************************/
//#include
#include
double ExecTime()
/* -------- */
{
struct timeval TV;
struct timezone TZ={0,0};
gettimeofday(&TV, &TZ);
return TV.tv_sec + TV.tv_usec / 1000000.0;
}
/*************************************************************************/
/* */
/* Determine precision of numeric value */
/* */
/*************************************************************************/
int Denominator(ContValue Val)
/* ----------- */
{
double RoundErr, Accuracy;
int Mult;
Accuracy = fabs(Val) * 1E-6; /* approximate */
Val = modf(Val, &RoundErr);
for ( Mult = 100000 ; Mult >= 1 ; Mult /= 10 )
{
RoundErr = fabs(rint(Val * Mult) / Mult - Val);
if ( RoundErr > 2 * Accuracy )
{
return Mult * 10;
}
}
return 1;
}
int FracBase(Attribute Att)
/* -------- */
{
CaseNo i;
int Denom=0, ThisDenom;
ForEach(i, 0, MaxCase)
{
if ( ! Unknown(Case[i], Att) &&
! NotApplic(Case[i], Att) &&
(ThisDenom = Denominator(CVal(Case[i], Att))) > Denom )
{
Denom = ThisDenom;
}
}
return Denom;
}
/*************************************************************************/
/* */
/* Routines to process date (Algorithm due to Gauss?) */
/* */
/*************************************************************************/
int GetInt(String S, int N)
/* ------ */
{
int Result=0;
while ( N-- )
{
if ( ! isdigit(*S) ) return 0;
Result = Result * 10 + (*S++ - '0');
}
return Result;
}
int DateToDay(String DS) /* Day 1 is 0000/03/01 */
/* --------- */
{
int Year, Month, Day;
if ( strlen(DS) != 10 ) return 0;
Year = GetInt(DS, 4);
Month = GetInt(DS+5, 2);
Day = GetInt(DS+8, 2);
if ( ! ( DS[4] == '/' && DS[7] == '/' || DS[4] == '-' && DS[7] == '-' ) ||
Year < 0 || Month < 1 || Day < 1 ||
Month > 12 ||
Day > 31 ||
Day > 30 &&
( Month == 4 || Month == 6 || Month == 9 || Month == 11 ) ||
Month == 2 &&
( Day > 29 ||
Day > 28 && ( Year % 4 != 0 ||
Year % 100 == 0 && Year % 400 != 0 ) ) )
{
return 0;
}
if ( (Month -= 2) <= 0 )
{
Month += 12;
Year -= 1;
}
return Year * 365 + Year / 4 - Year / 100 + Year / 400
+ 367 * Month / 12
+ Day - 30;
}
void DayToDate(int Day, String Date)
/* --------- */
{
int Year, Month, OrigDay=Day;
if ( Day <= 0 )
{
strcpy(Date, "?");
return;
}
Year = (Day - 1) / 365.2425L; /* Year = completed years */
Day -= Year * 365 + Year / 4 - Year / 100 + Year / 400;
if ( Day < 1 )
{
Year--;
Day = OrigDay - (Year * 365 + Year / 4 - Year / 100 + Year / 400);
}
else
if ( Day > 366 ||
Day == 366 &&
( (Year+1) % 4 != 0 || (Year+1) % 100 == 0 && (Year+1) % 400 != 0 ) )
{
Year++;
Day = OrigDay - (Year * 365 + Year / 4 - Year / 100 + Year / 400);
}
Month = (Day + 30) * 12 / 367;
Day -= 367 * Month / 12 - 30;
if ( Day < 1 )
{
Month = 11;
Day = 31;
}
Month += 2;
if ( Month > 12 )
{
Month -= 12;
Year++;
}
sprintf(Date, "%d/%d%d/%d%d", Year, Month/10, Month % 10, Day/10, Day % 10);
}
/*************************************************************************/
/* */
/* Routines to process clock time and timestamps */
/* */
/*************************************************************************/
int TimeToSecs(String TS)
/* ---------- */
{
int Hour, Mins, Secs;
if ( strlen(TS) != 8 ) return -1;
Hour = GetInt(TS, 2);
Mins = GetInt(TS+3, 2);
Secs = GetInt(TS+6, 2);
if ( TS[2] != ':' || TS[5] != ':' ||
Hour >= 24 || Mins >= 60 || Secs >= 60 )
{
return -1;
}
return Hour * 3600 + Mins * 60 + Secs;
}
void SecsToTime(int Secs, String Time)
/* ---------- */
{
int Hour, Mins;
Hour = Secs / 3600;
Mins = (Secs % 3600) / 60;
Secs = Secs % 60;
sprintf(Time, "%d%d:%d%d:%d%d",
Hour / 10, Hour % 10,
Mins / 10, Mins % 10,
Secs / 10, Secs % 10);
}
void SetTSBase(int y)
/* --------- */
{
y -= 15;
TSBase = y * 365 + y / 4 - y / 100 + y / 400 + (367 * 4) / 12 + 1 - 30;
}
int TStampToMins(String TS)
/* ------------ */
{
int Day, Sec, i;
/* Check for reasonable length and space between date and time */
if ( strlen(TS) < 19 || ! Space(TS[10]) ) return (1 << 30);
/* Read date part */
TS[10] = '\00';
Day = DateToDay(TS);
TS[10] = ' ';
/* Skip one or more spaces */
for ( i = 11 ; TS[i] && Space(TS[i]) ; i++ )
;
/* Read time part */
Sec = TimeToSecs(TS+i);
/* Return a long time in the future if there is an error */
return ( Day < 1 || Sec < 0 ? (1 << 30) :
(Day - TSBase) * 1440 + (Sec + 30) / 60 );
}
/*************************************************************************/
/* */
/* Convert a continuous value to a string. DS must be */
/* large enough to hold any value (e.g. a date, time, ...) */
/* */
/*************************************************************************/
void CValToStr(ContValue CV, Attribute Att, String DS)
/* --------- */
{
int Mins;
if ( TStampVal(Att) )
{
DayToDate(floor(CV / 1440) + TSBase, DS);
DS[10] = ' ';
Mins = rint(CV) - floor(CV / 1440) * 1440;
SecsToTime(Mins * 60, DS+11);
}
else
if ( DateVal(Att) )
{
DayToDate(CV, DS);
}
else
if ( TimeVal(Att) )
{
SecsToTime(CV, DS);
}
else
{
sprintf(DS, "%.*g", PREC, CV);
}
}
/*************************************************************************/
/* */
/* Check option value */
/* */
/*************************************************************************/
void Check(float Val, float Low, float High)
/* ----- */
{
if ( Val < Low || Val > High )
{
printf("\t** illegal value %g -- should be between %g and %g\n",
Val, Low, High);
exit(1);
}
}
#ifdef UTF8
///////////////////////////////////////////////////////////////////////////
// //
// Routines for Unicode/UTF-8 processing //
// ------------------------------------- //
// //
///////////////////////////////////////////////////////////////////////////
#include
/*************************************************************************/
/* */
/* Determine the total character width of a UTF-8 string */
/* */
/*************************************************************************/
int UTF8CharWidth(unsigned char *U)
/* ------------- */
{
int CWidth=0, Mask, This;
wchar_t Unicode;
while ( *U )
{
Unicode = *U;
if ( *U < 0x7F )
{
/* ASCII character */
CWidth++;
U++;
}
else
{
/* Discard header bits */
Mask = 0x80;
while ( Unicode & Mask )
{
Unicode ^= Mask;
Mask = Mask >> 1;
}
while ( ((*(++U)) & 0xc0) == 0x80 )
{
Unicode = (Unicode << 6) | (*U & 0x3f);
}
if ( (This = wcwidth(Unicode)) > 0 ) CWidth += This;
}
}
return CWidth;
}
////////////////////////////////////////////////////////////////////////////////
// Public domain code to determine the width of a Unicode character //
////////////////////////////////////////////////////////////////////////////////
/*
* This is an implementation of wcwidth() and wcswidth() as defined in
* "The Single UNIX Specification, Version 2, The Open Group, 1997"
*
*
* Markus Kuhn -- 2000-02-08 -- public domain
*/
//#include
/* These functions define the column width of an ISO 10646 character
* as follows:
*
* - The null character (U+0000) has a column width of 0.
*
* - Other C0/C1 control characters and DEL will lead to a return
* value of -1.
*
* - Non-spacing and enclosing combining characters (general
* category code Mn or Me in the Unicode database) have a
* column width of 0.
*
* - Spacing characters in the East Asian Wide (W) or East Asian
* FullWidth (F) category as defined in Unicode Technical
* Report #11 have a column width of 2.
*
* - All remaining characters (including all printable
* ISO 8859-1 and WGL4 characters, Unicode control characters,
* etc.) have a column width of 1.
*
* This implementation assumes that wchar_t characters are encoded
* in ISO 10646.
*/
int wcwidth(wchar_t ucs)
{
/* sorted list of non-overlapping intervals of non-spacing characters */
static const struct interval {
unsigned short first;
unsigned short last;
} combining[] = {
{ 0x0300, 0x034E }, { 0x0360, 0x0362 }, { 0x0483, 0x0486 },
{ 0x0488, 0x0489 }, { 0x0591, 0x05A1 }, { 0x05A3, 0x05B9 },
{ 0x05BB, 0x05BD }, { 0x05BF, 0x05BF }, { 0x05C1, 0x05C2 },
{ 0x05C4, 0x05C4 }, { 0x064B, 0x0655 }, { 0x0670, 0x0670 },
{ 0x06D6, 0x06E4 }, { 0x06E7, 0x06E8 }, { 0x06EA, 0x06ED },
{ 0x0711, 0x0711 }, { 0x0730, 0x074A }, { 0x07A6, 0x07B0 },
{ 0x0901, 0x0902 }, { 0x093C, 0x093C }, { 0x0941, 0x0948 },
{ 0x094D, 0x094D }, { 0x0951, 0x0954 }, { 0x0962, 0x0963 },
{ 0x0981, 0x0981 }, { 0x09BC, 0x09BC }, { 0x09C1, 0x09C4 },
{ 0x09CD, 0x09CD }, { 0x09E2, 0x09E3 }, { 0x0A02, 0x0A02 },
{ 0x0A3C, 0x0A3C }, { 0x0A41, 0x0A42 }, { 0x0A47, 0x0A48 },
{ 0x0A4B, 0x0A4D }, { 0x0A70, 0x0A71 }, { 0x0A81, 0x0A82 },
{ 0x0ABC, 0x0ABC }, { 0x0AC1, 0x0AC5 }, { 0x0AC7, 0x0AC8 },
{ 0x0ACD, 0x0ACD }, { 0x0B01, 0x0B01 }, { 0x0B3C, 0x0B3C },
{ 0x0B3F, 0x0B3F }, { 0x0B41, 0x0B43 }, { 0x0B4D, 0x0B4D },
{ 0x0B56, 0x0B56 }, { 0x0B82, 0x0B82 }, { 0x0BC0, 0x0BC0 },
{ 0x0BCD, 0x0BCD }, { 0x0C3E, 0x0C40 }, { 0x0C46, 0x0C48 },
{ 0x0C4A, 0x0C4D }, { 0x0C55, 0x0C56 }, { 0x0CBF, 0x0CBF },
{ 0x0CC6, 0x0CC6 }, { 0x0CCC, 0x0CCD }, { 0x0D41, 0x0D43 },
{ 0x0D4D, 0x0D4D }, { 0x0DCA, 0x0DCA }, { 0x0DD2, 0x0DD4 },
{ 0x0DD6, 0x0DD6 }, { 0x0E31, 0x0E31 }, { 0x0E34, 0x0E3A },
{ 0x0E47, 0x0E4E }, { 0x0EB1, 0x0EB1 }, { 0x0EB4, 0x0EB9 },
{ 0x0EBB, 0x0EBC }, { 0x0EC8, 0x0ECD }, { 0x0F18, 0x0F19 },
{ 0x0F35, 0x0F35 }, { 0x0F37, 0x0F37 }, { 0x0F39, 0x0F39 },
{ 0x0F71, 0x0F7E }, { 0x0F80, 0x0F84 }, { 0x0F86, 0x0F87 },
{ 0x0F90, 0x0F97 }, { 0x0F99, 0x0FBC }, { 0x0FC6, 0x0FC6 },
{ 0x102D, 0x1030 }, { 0x1032, 0x1032 }, { 0x1036, 0x1037 },
{ 0x1039, 0x1039 }, { 0x1058, 0x1059 }, { 0x17B7, 0x17BD },
{ 0x17C6, 0x17C6 }, { 0x17C9, 0x17D3 }, { 0x18A9, 0x18A9 },
{ 0x20D0, 0x20E3 }, { 0x302A, 0x302F }, { 0x3099, 0x309A },
{ 0xFB1E, 0xFB1E }, { 0xFE20, 0xFE23 }
};
int min = 0;
int max = sizeof(combining) / sizeof(struct interval) - 1;
int mid;
/* test for 8-bit control characters */
if (ucs == 0)
return 0;
if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0))
return -1;
/* first quick check for Latin-1 etc. characters */
if (ucs < combining[0].first)
return 1;
/* binary search in table of non-spacing characters */
while (max >= min) {
mid = (min + max) / 2;
if (combining[mid].last < ucs)
min = mid + 1;
else if (combining[mid].first > ucs)
max = mid - 1;
else if (combining[mid].first <= ucs && combining[mid].last >= ucs)
return 0;
}
/* if we arrive here, ucs is not a combining or C0/C1 control character */
/* fast test for majority of non-wide scripts */
if (ucs < 0x1100)
return 1;
return 1 +
((ucs >= 0x1100 && ucs <= 0x115f) || /* Hangul Jamo */
(ucs >= 0x2e80 && ucs <= 0xa4cf && (ucs & ~0x0011) != 0x300a &&
ucs != 0x303f) || /* CJK ... Yi */
(ucs >= 0xac00 && ucs <= 0xd7a3) || /* Hangul Syllables */
(ucs >= 0xf900 && ucs <= 0xfaff) || /* CJK Compatibility Ideographs */
(ucs >= 0xfe30 && ucs <= 0xfe6f) || /* CJK Compatibility Forms */
(ucs >= 0xff00 && ucs <= 0xff5f) || /* Fullwidth Forms */
(ucs >= 0xffe0 && ucs <= 0xffe6));
}
int wcswidth(const wchar_t *pwcs, size_t n)
{
int w, width = 0;
for (;*pwcs && n-- > 0; pwcs++)
if ((w = wcwidth(*pwcs)) < 0)
return -1;
else
width += w;
return width;
}
#endif