diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,511 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control +compilation and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply, and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License +may add an explicit geographical distribution limitation excluding those +countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +It is safest to attach them to the start of each source file to most +effectively convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + + diff --git a/Data/GiST/BTree.hs b/Data/GiST/BTree.hs new file mode 100644 --- /dev/null +++ b/Data/GiST/BTree.hs @@ -0,0 +1,72 @@ +{- | +Module : BTree +Copyright : (c) Mihail Bogojeski +License : GPL + +Maintainer : mihailbogojeski@gmail.com +Stability : experimental +Portability : portable + +A simple implementation of the B+ tree predicate. A containment predicate is a tuple of two integers +representing an open interval, while the equality predicate is simply an interger value. +-} + +{-# LANGUAGE MultiParamTypeClasses + #-} + + + +module Data.GiST.BTree ( + Predicate (..) + ,between +) where + +import Data.GiST.GiST(Entry(..),entryPredicate,Predicates(..),Penalty) +import Data.List(sort) + + + +data Predicate a = Contains (a,a) -- ^ containment predicate (interval) + | Equals a -- ^ equality predicate (integer value) + deriving (Eq, Ord, Show, Read) + + + +-- | More documentation on the instance implementation in the source +instance Predicates Predicate Int where + + -- | Two containment predicates are consistent if the intervals they represent overlap + -- A containment and equality predicate are consistent if the interval represented by the former contains the value of the latter + -- Two equality predicates are consistent if they represent the same value + consistent (Contains (min1,max1)) (NodeEntry (_, Contains (min2,max2))) = (min1 <= max2) && (max1 >= min2) + consistent (Equals a) (NodeEntry (_, Contains (min,max))) = between a min max + consistent (Contains (min,max)) (LeafEntry (_, Equals a)) = between a min max + consistent (Equals a1) (LeafEntry (_, Equals a2)) = a1 == a2 + + -- | A union of predicates is an interval spanning from the minimal + -- to the maximal value of all the predicats + union ps = Contains (min,max) + -- The minimum of all interval minimums + where min = minimum $ map minP ps + -- The maximum of all interval maximums + max = maximum $ map maxP ps + + -- | Seperates the sorted list of entries into two halves + pickSplit es = splitAt ((length es + 1) `div` 2) sorted + where sorted = sort es + -- | The distance between the intervals (or values) of the predicates + penalty p1 p2 = maximum[(minP p2)-(minP p1), 0] + maximum [(maxP p1)-(maxP p2),0] + +-- The lower limit of the predicate +minP :: Predicate a -> a +minP (Contains (min,_)) = min +minP (Equals a) = a + +-- The upper limit of the predicate +maxP :: Predicate a -> a +maxP (Contains (_,max)) = max +maxP (Equals a) = a + +-- | Tests if a value is between two others +between :: Ord a => a -> a -> a -> Bool +between a min max = (a >= min) && (a <= max) diff --git a/Data/GiST/GiST.hs b/Data/GiST/GiST.hs new file mode 100644 --- /dev/null +++ b/Data/GiST/GiST.hs @@ -0,0 +1,223 @@ +{- | +Module : GiST +Copyright : (c) Mihail Bogojeski, Alexander Svozil +License : GPL + +Maintainer : mihailbogojeski@gmail.com +Stability : experimental +Portability : portable + +The implementation of the basic GiST operations. The behaviour +of the operations is largely influenced by the predicate used, allowing the GiST to behave +like a different type of balanced search tree for a different predicate. Although the operations +are influenced by the predicate, it is always ensured that the tree stays balanced after an +insertion or deletion, regardless of the predicate used. It is also recommended that the minimum +and maximum fill factor for the tree are constant throughout the whole program to ensure optimal +behaviour +-} + + +{-# LANGUAGE MultiParamTypeClasses + ,FlexibleInstances + ,FlexibleContexts + #-} + +module Data.GiST.GiST + ( + -- ** Types + GiST + ,Entry(..) + ,Predicates(..) + ,LeafEntry,NodeEntry,Penalty + ,entryPredicate + -- ** GiST operations + ,search, insert, delete, empty, save, load, getData, size + ) where + +import Data.GiST.Types +import qualified Data.Text.IO as TIO +import qualified Data.Text as T + + +-- | Searches the GiST for leaf nodes that satisfy the given search predicate +search :: Predicates p a => p a -> GiST p a -> [a] +search p (Leaf es) = [fst e | e <- es, consistent p (LeafEntry e)] +search _ (Node []) = [] +search p (Node (e:es)) + |consistent p (NodeEntry e) = (search p (fst e)) ++ (search p (Node es)) + |otherwise = search p (Node es) + +-- | Inserts an entry into the tree, rebalancing the tree if necessary. +-- Rebalancing is done to satisfy the minimum and maximum fill factor +-- of the tree (represented as an integer tuple) +insert :: Predicates p a => LeafEntry p a -> (Int, Int) -> GiST p a -> GiST p a +insert (toIns, pred) (min,max) (Node es) + |search pred (Node es) /= [] = Node es + |length newEs <= max = Node newEs + |otherwise = Node [(Node $ map unNodeEntry es1, union $ map entryPredicate es1) + ,(Node $ map unNodeEntry es2, union $ map entryPredicate es2)] + -- The new entries after inserting + where newEs = case insertSubtree of + Right newSub -> [if (e == minSubtree) + then newSub + else e + |e <- es] + Left split -> (filter (/=minSubtree) es)++[fst split,snd split] + -- The optimal subtree to insert into + minSubtree = chooseSubtree es (toIns,pred) + -- The changed (and additional) subtree after insert + insertSubtree = insertAndSplit minSubtree (min,max) (toIns,pred) + -- The split of the node entries (in case of overpopulation) + (es1,es2) = pickSplit $ map NodeEntry newEs + +insert (toIns, p) (min,max) (Leaf es) + |search p (Leaf es) /= [] = Leaf es + |length newEs <= max = Leaf newEs + |otherwise = Node [(Leaf $ map unLeafEntry es1,union $ map entryPredicate es1) + ,(Leaf $ map unLeafEntry es2, union $ map entryPredicate es2)] + -- The new entries after insert + where newEs = (toIns, p):es + -- The split of the node entries (in case of overpopulation) + (es1,es2) = pickSplit $ map LeafEntry newEs + +-- | Deletes a leaf entry from the tree, rebalancing the tree if necessary. +-- Rebalancing is done to satisfy the minimum and maximum fill factor +-- of the tree (represented as an integer tuple) +delete :: Predicates p a => LeafEntry p a -> (Int, Int) -> GiST p a -> GiST p a +delete (toDel, p) (min,max) (Node es) + |length newEs == 1 = insertMultiple toAdd (makeRoot $ head newEs) (min,max) + |otherwise = insertMultiple toAdd (Node newEs) (min, max) + -- The new entries after delete without Null entries + where newEs = filter (not.isNull) (map fst delNodes) + -- The propagated entries to add + toAdd = concat (map snd delNodes) + -- The entries after delete + delNodes = [if (consistent p (NodeEntry e)) + then (deleteAndCondense e (min,max) (toDel,p)) + else (e,[]) + |e <- es] + +delete (toDel, p) (min,max) (Leaf es) = Leaf [e | e <- es, not $ consistent p (LeafEntry e)] + +-- | Create a new empty GiST +empty :: GiST p a +empty = Leaf [] + +-- | Loads a GiST from file +load :: (Read a, Read (p a)) => FilePath -> IO (GiST p a) +load f = do s <- TIO.readFile f + return (read $ T.unpack s) + +-- | Saves the GiST to file +save :: (Show a, Show (p a)) => GiST p a -> FilePath -> IO () +save gist f = TIO.writeFile f $ T.pack (show gist) + + + + +-- | A helper function that propagates insertion through the subtrees and splits when necessary. +-- If the node is overpopulated after the insertion, the node is split into +-- two smaller nodes which are then added to the parent +insertAndSplit :: (Predicates p a) => NodeEntry p a -> (Int,Int) -> LeafEntry p a -> Either (NodeEntry p a, NodeEntry p a) (NodeEntry p a) +insertAndSplit (Node es,p) (min,max) (toIns,pred) + |length newEs <= max = Right (Node newEs,union $ map snd newEs) + |otherwise = Left ((Node (map unNodeEntry es1), union $ map entryPredicate es1) + ,(Node (map unNodeEntry es2), union $ map entryPredicate es2)) + -- The new entries after insert + where newEs = case insertSubtree of + Right newSub -> [if (e == minSubtree) + then newSub + else e + |e <- es] + Left split -> (filter (/=minSubtree) es)++[fst split,snd split] + -- The optimal subtree to insert into + minSubtree = chooseSubtree es (toIns,pred) + -- The changed (and additional) subtree after insert + insertSubtree = insertAndSplit minSubtree (min,max) (toIns,pred) + -- The split of the node entries (in case of overpopulation) + (es1,es2) = pickSplit $ map NodeEntry newEs + +insertAndSplit (Leaf es,p) (min,max) (toIns,pred) + |length newEs <= max = Right (Leaf newEs,union $ map snd newEs) + |otherwise = Left ((Leaf (map unLeafEntry es1), union $ map entryPredicate es1) + ,(Leaf (map unLeafEntry es2), union $ map entryPredicate es2)) + -- The optimal subtree to insert into + where newEs = ((toIns,pred) : es) + -- The split of the node entries (in case of overpopulation) + (es1,es2) = pickSplit $ map LeafEntry newEs + + +-- A helper function that propagates deletion through the subtrees and condenses. +-- If an internal node is underpopulated after deletion, the node and all it's subnodes are removed +-- and all their leaf entries are stored for reinsertion. The deletion is then propagated to the parent +-- of the node +deleteAndCondense :: (Predicates p a) => NodeEntry p a -> (Int,Int) -> LeafEntry p a -> (NodeEntry p a, [LeafEntry p a]) +deleteAndCondense (Node es, pred) (min, max) (toDel, p) + |length newEs < min = ((Null, pred), toAdd ++ getEntries (Node es)) + |otherwise = ((Node newEs, union $ map snd newEs), toAdd) + -- The new entries after delete without Null entries + where newEs = filter (not.isNull) (map fst delNodes) + -- The propagated entries to add + toAdd = concat (map snd delNodes) + -- The entries after delete + delNodes = [if (consistent p (NodeEntry e)) + then (deleteAndCondense e (min,max) (toDel,p)) + else (e,[]) + |e <- es] +-- If a leaf is underpopulated after deletion, the leaf is removed and all its entries are +-- stored for reinsertion. The deletion is then propagated to the parent of the node +deleteAndCondense ((Leaf es),pred) (min, max) (toDel, p) + |length newEs < min = ((Null,pred), newEs) + |otherwise = ((Leaf newEs, union $ map snd newEs),[]) + -- The new entries after delete without Null entries + where newEs = [e | e <- es, not $ consistent p (LeafEntry e)] + + + +-- Inserts multiple entries into a GiST +insertMultiple :: (Predicates p a) => [LeafEntry p a] -> GiST p a -> (Int,Int) -> GiST p a +insertMultiple [] gist _ = gist +insertMultiple (e:es) gist (min,max) = insertMultiple es afterInsert (min,max) + where afterInsert = insert e (min,max) gist + + + +-- Chooses the most appropriate subtree to insert the entry into +chooseSubtree :: (Predicates p a )=>[(NodeEntry p a)] -> LeafEntry p a -> (NodeEntry p a) +chooseSubtree subtrees e = minPenalty penalties (head penalties) + where penalties = [(ne, penalty (snd e) (snd ne))|ne <- subtrees] + + +-- Return the minimum penalty and corresponding entry from a list od entries and penalties +minPenalty :: [(NodeEntry p a, Penalty)]->(NodeEntry p a, Penalty) -> NodeEntry p a +minPenalty [] p = fst p +minPenalty ((ne, pen):ps) (nemin, minpen) + |pen < minpen = minPenalty ps (ne, pen) + |otherwise = minPenalty ps (nemin, minpen) + + +-- Takes an entry and extracts the GiST from it +makeRoot :: NodeEntry p a -> GiST p a +makeRoot (Node es, p) = Node es +makeRoot (Leaf es, p) = Leaf es + + +-- Checks if an entry contains a Null GiST +isNull :: NodeEntry p a -> Bool +isNull (Null, p) = True +isNull _ = False + + +-- Returns all the entries stored in a GiST +getEntries :: GiST p a -> [LeafEntry p a] +getEntries (Node es) = concat [getEntries sub | (sub,_) <- es] +getEntries (Leaf es) = es + + +-- | Returns all the data stored in a GiST +getData :: GiST p a -> [a] +getData gist = map fst $ getEntries gist + +-- | Return the number of values in a GiST +size :: GiST p a -> Int +size gist = length $ getEntries gist diff --git a/Data/GiST/RTree.hs b/Data/GiST/RTree.hs new file mode 100644 --- /dev/null +++ b/Data/GiST/RTree.hs @@ -0,0 +1,115 @@ +{- | +Module : RTree +Copyright : (c) Mihail Bogojeski +License : GPL + +Maintainer : mihailbogojeski@gmail.com +Stability : experimental +Portability : portable + +A simple implementation of the R-Tree predicate. A containment predicate is a tuple of two points +representing a rectangle with the first tuple (minx,maxy) being the upper left corner of the rectangle +and the second (maxx,miny) being the lower right corner of the rectangle, while the equality predicate +is simply a 2D point (tuple of two integers). +-} + + +{-# LANGUAGE MultiParamTypeClasses + , FlexibleInstances + #-} + +module Data.GiST.RTree ( + Predicate(..) +) where + +import Data.GiST.GiST(Entry(..),entryPredicate,Predicates(..),Penalty) +import Data.GiST.BTree(between) +import Data.List(sort) + + +data Predicate a = Contains (a,a) -- ^ containment predicate (rectangle) + | Equals a -- ^ equality predicate (2D point) + deriving (Eq,Ord,Show,Read) + +-- Checks if the intervals of two R-Tree predicates overlap +overlaps :: (Ord a) => ((a,a),(a,a)) -> ((a,a),(a,a)) -> Bool +overlaps ((minx1,maxy1),(maxx1,miny1)) ((minx2,maxy2),(maxx2,miny2)) = (minx1 <= maxx2) + && (minx2 <= maxx1) + && (miny1 <= maxy2) + && (miny2 <= maxy1) + +-- | More documentation on the instance implementation in the source +instance Predicates Predicate (Int,Int) where + + -- | Two containment predicates are consistent if the rectangles they represent overlap. + -- A containment and equality predicate are consistent if the point represented by the latter + -- is in the area described by former. + -- Two equality predicates are consistent if they represent the same point + consistent (Contains t1) (NodeEntry (_, Contains t2)) = overlaps t1 t2 + consistent (Equals (x,y)) (NodeEntry (_, Contains ((minx,maxy),(maxx,miny)))) = between x minx maxx && between y miny maxy + consistent (Contains ((minx,maxy),(maxx,miny))) (LeafEntry (_, Equals (x,y))) = between x minx maxx && between y miny maxy + consistent (Equals a1) (LeafEntry (_, Equals a2)) = a1 == a2 + + -- | A union of predicates is a rectangle with the minimal x und maximal y coordinate of all predicates as the upper left corner + -- and the maximal x and minimal y coordinate of all predicates as the lower right corner + union ps = Contains ((minx,maxy),(maxx,miny)) + -- The minimum of all x interval minimums + where minx = minimum $ map minxP ps + -- The maximum of all y interval maximums + maxy = maximum $ map maxyP ps + -- The maximum of all x interval maximums + maxx = maximum $ map maxxP ps + -- The minimum of all y interval minimums + miny = minimum $ map minyP ps + + -- | Seperates the sorted list of entries into two halves using the linear split algorithm + pickSplit es = linearSplit [e1] [e2] [e | e <- sort es, e /= e1, e/= e2] $ (length es + 1) `div` 2 + -- A tuple containing the two most disparate entries in the list their corresponding penalty penalty + where (_, e1, e2) = maximum [greatestPenalty e es | e <- es] + + -- | The area increase of the second predicate after a union with the first + penalty p1 p2 = area (union [p1,p2]) - area p2 + + +-- | The lower limit for the x coordinate of the predicate +minxP :: Predicate (a,a) -> a +minxP (Contains ((minx,_),(_,_))) = minx +minxP (Equals (x,_)) = x + +-- | The upper limit for the y coordinate of the predicate +maxyP :: Predicate (a,a) -> a +maxyP (Contains ((_,maxy),(_,_))) = maxy +maxyP (Equals (_,y)) = y + +-- | The upper limit for the x coordinate of the predicate +maxxP :: Predicate (a,a) -> a +maxxP (Contains ((_,_),(maxx,_))) = maxx +maxxP (Equals (x,_)) = x + +-- | The lower limit for the y coordinate of the predicate +minyP :: Predicate (a,a) -> a +minyP (Contains ((_,_),(_,miny))) = miny +minyP (Equals (_,y)) = y + +-- | Size of the area covered by the predicate +area :: Predicate (Int,Int) -> Int +area (Equals _) = 0 +area (Contains ((minx,maxy),(maxx,miny))) = (maxx - minx) * (maxy - miny) + + +-- | Calculates the greatest penalty between an entry and a list of entries +-- | Returns a tuple containing the greatest penalty and the two entries for which the penalty was calculated +greatestPenalty :: Entry Predicate (Int,Int) -> [Entry Predicate (Int,Int)] -> (Penalty, Entry Predicate (Int,Int), Entry Predicate (Int,Int)) +greatestPenalty e es = maximum [(penalty (entryPredicate e) (entryPredicate e1), e, e1) | e1 <- es] + +-- | Implementation of the linear split algorithm taking the minimal fill factor into account +linearSplit :: [Entry Predicate (Int, Int)] -> [Entry Predicate (Int,Int)] -> + [Entry Predicate (Int,Int)] -> Int -> ([Entry Predicate (Int,Int)], [Entry Predicate (Int,Int)]) +linearSplit es1 es2 [] _ = (es1,es2) +linearSplit es1 es2 (e:es) max + |length es1 == max = (es1,es2 ++ (e:es)) + |length es2 == max = (es1 ++ (e:es), es2) + |otherwise = if penalty (entryPredicate e) (union $ map entryPredicate es1) > + penalty (entryPredicate e) (union $ map entryPredicate es2) + then linearSplit es1 (e:es2) es max + else linearSplit (e:es1) es2 es max diff --git a/Data/GiST/Types.hs b/Data/GiST/Types.hs new file mode 100644 --- /dev/null +++ b/Data/GiST/Types.hs @@ -0,0 +1,75 @@ +{- | +Module : Types +Copyright : (c) Mihail Bogojeski, Alexander Svozil +License : GPL + +Maintainer : mihailbogojeski@gmail.com +Stability : experimental +Portability : portable + +Defines the basic types used for this GiST implementation and a couple of operations on these types. +Also introduces the Predicates class which the user of this package can instance to create predicates +which define the data stored in the tree and the tree's behavior during insert, delete, and search operations +-} + + +{-# LANGUAGE MultiParamTypeClasses + ,FlexibleInstances + ,FlexibleContexts + #-} + +module Data.GiST.Types where + +import Data.Foldable as F + +-- | The data structure used for building the GiST +data GiST p a = Leaf [LeafEntry p a] -- ^ leaf node + | Node [NodeEntry p a] -- ^ internal node + | Null -- ^ a null GiST + deriving (Eq, Show, Read) + + +-- | A general entry type for the gist +data Entry p a = LeafEntry (LeafEntry p a) + | NodeEntry (NodeEntry p a) + deriving (Eq, Show, Read) + +unLeafEntry (LeafEntry l) = l +unNodeEntry (NodeEntry n) = n + +-- | Returns the predicate of this entry +entryPredicate :: Entry p a -> p a +entryPredicate (LeafEntry e) = snd e +entryPredicate (NodeEntry e) = snd e + +-- | A leaf entry has a predicate and data +type LeafEntry p a = (a, p a) + +-- | A node entry has a predicate and a subtree +type NodeEntry p a = (GiST p a, p a) + +type Penalty = Int + +-- | Comparison only based on the predicate +instance (Eq a, Ord (p a)) => Ord (Entry p a) where + (<=) (LeafEntry (_,p1)) (LeafEntry (_,p2)) = p1 <= p2 + (<=) (NodeEntry (_,p1)) (NodeEntry (_,p2)) = p1 <= p2 + (<=) (NodeEntry (_,p1)) (LeafEntry (_,p2)) = p1 <= p2 + (<=) (LeafEntry (_,p1)) (NodeEntry (_,p2)) = p1 <= p2 + + +-- | The predicate class that can be instanced by the user to create new types +-- of balanced search trees +class (Eq a, Eq (p a)) => Predicates p a where + -- | Checks if the given entry is consistent with a given predicate + consistent :: p a -> Entry p a -> Bool + -- | Returns a predicate that is the union of all predicates of the given list of entries + union :: [p a] -> p a + -- | Calculates a numerical penalty for inserting the entry containing the first predicate + -- into a subtree rooted at an entry containing the second predicate + penalty :: p a -> p a -> Penalty + -- | Given a list of entries, returns two disjunct subsets that contain the entries in the list. + -- Focus is on minimising the overlap between the splitted entries' predicates + pickSplit :: [Entry p a] -> ([Entry p a], [Entry p a]) + + diff --git a/GiST.cabal b/GiST.cabal new file mode 100644 --- /dev/null +++ b/GiST.cabal @@ -0,0 +1,26 @@ +name: GiST +version: 0.0.1 +cabal-version: >=1.2 +build-type: Simple +license: GPL +license-file: LICENSE +author: Mihail Bogojeski, Alexander Svozil +maintainer: Mihail Bogojeski (mihailbogojeski@gmail.com) +extra-source-files: COPYING, Test/Random.hs, Test/Tests.hs, Test/RandomFast.hs, Test/Interactive.hs +synopsis: A Haskell implementation of a Generalized Search Tree (GiST) +description: A simple implementation of the GiST data structure, including a couple of basic + predicates used for implementing a GiST based B+ or R-tree. The GiST is also + capable und working with any user defined instance of the class Predicates, + making this package perfect for developing and testing new types of balanced + trees. +category: Data Structures +stability: Experimental +tested-with: GHC == 7.4.1 + +library + buildable: True + build-depends: base >=4 && <5, text >= 0.11.2.3 && <0.12 + exposed-modules: Data.GiST.GiST, + Data.GiST.BTree, + Data.GiST.RTree + other-modules: Data.GiST.Types diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Copyright (C) 2013 Mihail Bogojeski , Alexander Svozil + +All code is under the following license unless otherwise noted: + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +The GNU Lesser General Public License is available in the file COPYING in the +source distribution. Debian GNU/Linux users may find this in +/usr/share/common-licenses/GPL-2. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,3 @@ +#!/usr/bin/runhaskell +import Distribution.Simple +main = defaultMain diff --git a/Test/Interactive.hs b/Test/Interactive.hs new file mode 100644 --- /dev/null +++ b/Test/Interactive.hs @@ -0,0 +1,84 @@ +{-# LANGUAGE MultiParamTypeClasses + #-} + +module Main where + +import System.IO +import System.Exit +import Data.GiST.GiST +import qualified Data.GiST.BTree as BTree +import qualified Data.GiST.RTree as RTree +import Control.Monad(when) +import System.Environment(getArgs) +import System.Console.GetOpt +import qualified Data.Text.IO as TIO +import qualified Data.Text as T + +-- | A small programm used for adding, deleting or searching data in a GiST saved on a file +-- options b and r choose between a BTree or RTree implementation +-- Option e for creating an empty gist, i for adding data into the tree, d for deleting and s for searching +main :: IO() +main = do + args <- getArgs + let (flags, nonOpt, msgs) = getOpt RequireOrder options args + when (length flags /=2) $ do + putStrLn "usage : main <-b|-r> <-i key|-d key|-s interval|-e> file" + exitFailure + when (length nonOpt /= 1) $ do + putStrLn "usage : main <-b|-r> <-i key|-d key|-s interval|-e> file" + exitFailure + let treeFlag = head flags + let opFlag = flags!!1 + let file = nonOpt!!0 + if (treeFlag == BTree ) then do + if (opFlag == Empty) then save (empty::GiST BTree.Predicate Int) file + else do + gist <- load file + executeOperationB gist opFlag file + else do + if (opFlag == Empty) then save (empty::GiST RTree.Predicate (Int,Int)) file + else do + gist <- load file + executeOperationR gist opFlag file + + + +data Flag = BTree | RTree | Search String | Insert String | Delete String | Empty deriving (Eq) + +options :: [OptDescr Flag] +options = [ + Option ['b'] ["btree"] (NoArg BTree) "use BTree GiST", + Option ['r'] ["rtree"] (NoArg RTree) "use RTree GiST", + Option ['s'] ["search"] (ReqArg Search "DATA") "search in GiST", + Option ['i'] ["insert"] (ReqArg Insert "DATA") "insert into GiST", + Option ['d'] ["delete"] (ReqArg Delete "DATA") "delete from GiST", + Option ['e'] ["empty"] (NoArg Empty) "write empty GiST" + ] + +executeOperationB :: GiST BTree.Predicate Int -> Flag -> String -> IO() +executeOperationB gist (Insert s) file = do + let key = read s :: Int + save (insert (key, BTree.Equals key) (2,4) gist) file +executeOperationB gist (Delete s) file = do + let key = read s :: Int + save (delete (key, BTree.Equals key) (2,4) gist) file +executeOperationB gist (Search s) file = do + let (min,max) = read s :: (Int,Int) + when (min >= max) $ do + putStrLn "usage for BTree : main <-i key|-d key|-s (min,max)>" + exitFailure + putStrLn $ show (search (BTree.Contains (min,max)) gist) + +executeOperationR :: GiST RTree.Predicate (Int,Int) -> Flag -> String -> IO() +executeOperationR gist (Insert s) file = do + let key = read s :: (Int,Int) + save (insert (key, RTree.Equals key) (2,4) gist) file +executeOperationR gist (Delete s) file = do + let key = read s :: (Int,Int) + save (delete (key, RTree.Equals key) (2,4) gist) file +executeOperationR gist (Search s) file = do + let ((minx,maxy),(maxx,miny)) = read s :: ((Int,Int),(Int,Int)) + when (minx > maxy || miny > maxy) $ do + putStrLn "usage for RTree : main <-i key|-d key|-s ((minx,maxy),(maxx,miny))>" + exitFailure + putStrLn $ show (search (RTree.Contains ((minx,maxy),(maxx,miny))) gist) diff --git a/Test/Random.hs b/Test/Random.hs new file mode 100644 --- /dev/null +++ b/Test/Random.hs @@ -0,0 +1,74 @@ +{-# LANGUAGE MultiParamTypeClasses + #-} + +module Main where + +import System.IO +import System.Exit +import System.Random +import Data.GiST.GiST +import qualified Data.GiST.BTree as BTree +import qualified Data.GiST.RTree as RTree +import Control.Monad(when) +import System.Environment(getArgs) +import System.Console.GetOpt +import qualified Data.Text.IO as TIO +import qualified Data.Text as T + + +-- | A small program that allows the user to add any number of random elements to a GiST and saves the resulting tree in the +-- "RandomBTree.txt" or "RandomRTree.txt" depending on the predicate type +-- The GiST is written after every insert +main :: IO() +main = do + args <- getArgs + let (flags, nonOpt, msgs) = getOpt RequireOrder options args + when (length flags /=1) $ do + putStrLn "usage : main <-b|-r> max_range num_inserts" + exitFailure + when (length nonOpt /= 2) $ do + putStrLn "usage : main <-b|-r> max_range num_inserts" + exitFailure + if (head flags == BTree ) then do + let gist = empty :: GiST BTree.Predicate Int + let file = "BTreeRandom.txt" + save gist file + g <- newStdGen + executeOperationB file (read $ nonOpt!!0) (read $ nonOpt!!1) g + else do + let gist = empty :: GiST RTree.Predicate (Int,Int) + let file = "RTreeRandom.txt" + save gist file + g <- newStdGen + executeOperationR file (read $ nonOpt!!0) (read $ nonOpt!!1) g + + + +data Flag = BTree | RTree deriving (Eq) + +options :: [OptDescr Flag] +options = [ + Option ['b'] ["btree"] (NoArg BTree) "use BTree GiST", + Option ['r'] ["rtree"] (NoArg RTree) "use RTree GiST" + ] + + + +executeOperationB :: String -> Int -> Int -> StdGen -> IO() +executeOperationB _ _ 0 _ = return() +executeOperationB file max num gen = do + gist <- (load file :: IO (GiST BTree.Predicate Int)) + let (key,g) = randomR (1,max) gen + putStrLn $ show $ length $ getEntries gist + save (insert (key, BTree.Equals key) (3,6) gist) file + executeOperationB file max (num-1) g + +executeOperationR :: String -> Int -> Int -> StdGen -> IO() +executeOperationR _ _ 0 _ = return() +executeOperationR file max num gen = do + gist <- (load file :: IO (GiST RTree.Predicate (Int,Int))) + let (x,g) = randomR (1,max) gen + let (y,g2) = randomR (1,max) g + putStrLn $ show $ length $ getEntries gist + save (insert ((x,y), RTree.Equals (x,y)) (3,6) gist) file + executeOperationR file max (num-1) g2 diff --git a/Test/RandomFast.hs b/Test/RandomFast.hs new file mode 100644 --- /dev/null +++ b/Test/RandomFast.hs @@ -0,0 +1,66 @@ +{-# LANGUAGE MultiParamTypeClasses + #-} + +module Main where + +import System.IO +import System.Exit +import System.Random +import Data.GiST.GiST +import qualified Data.GiST.BTree as BTree +import qualified Data.GiST.RTree as RTree +import Control.Monad(when) +import System.Environment(getArgs) +import System.Console.GetOpt +import qualified Data.Text.IO as TIO +import qualified Data.Text as T + +-- | A small program that allows the user to add any number of random elements to a GiST and saves the resulting tree in the +-- "RandomBTree.txt" or "RandomRTree.txt" depending on the predicate type +-- The data is written after all the insertions are finished +main :: IO() +main = do + args <- getArgs + let (flags, nonOpt, msgs) = getOpt RequireOrder options args + when (length flags /=1) $ do + putStrLn "usage : main <-b|-r> max_range num_inserts" + exitFailure + when (length nonOpt /= 2) $ do + putStrLn "usage : main <-b|-r> max_range num_inserts" + exitFailure + if (head flags == BTree ) then do + let gist = empty :: GiST BTree.Predicate Int + g <- newStdGen + let file = "BTreeRandom.txt" + save (executeOperationB gist (read $ nonOpt!!0) (read $ nonOpt!!1) g) file + + else do + let gist = empty :: GiST RTree.Predicate (Int,Int) + g <- newStdGen + let file = "RTreeRandom.txt" + save (executeOperationR gist (read $ nonOpt!!0) (read $ nonOpt!!1) g) file + + + + +data Flag = BTree | RTree deriving (Eq) + +options :: [OptDescr Flag] +options = [ + Option ['b'] ["btree"] (NoArg BTree) "use BTree GiST", + Option ['r'] ["rtree"] (NoArg RTree) "use RTree GiST" + ] + + +executeOperationB :: GiST BTree.Predicate Int -> Int -> Int -> StdGen -> GiST BTree.Predicate Int +executeOperationB g _ 0 _ = g +executeOperationB gist max num gen = executeOperationB inserted max (num-1) g + where inserted = insert (key, BTree.Equals key) (3,6) gist + (key,g) = randomR (1,max) gen + +executeOperationR :: GiST RTree.Predicate (Int,Int) -> Int -> Int -> StdGen -> GiST RTree.Predicate (Int,Int) +executeOperationR g _ 0 _ = g +executeOperationR gist max num gen = executeOperationR inserted max (num-1) g2 + where inserted = insert ((x,y), RTree.Equals (x,y)) (3,6) gist + (x,g) = randomR (1,max) gen + (y,g2) = randomR (1,max) g diff --git a/Test/Tests.hs b/Test/Tests.hs new file mode 100644 --- /dev/null +++ b/Test/Tests.hs @@ -0,0 +1,48 @@ +{-# LANGUAGE MultiParamTypeClasses + #-} + +module Test where + +import Data.GiST.GiST +import Data.List(sort) +import qualified Data.GiST.BTree as BTree +import qualified Data.GiST.RTree as RTree +-- | A small series of tests on the functionality of the GiST + +bounds = (2,5) +-- empty GiST +bg1 = empty::GiST BTree.Predicate Int +-- some elements added +bg2 = insert (50, BTree.Equals 50) bounds $ insert (32, BTree.Equals 32) bounds $ insert (7, BTree.Equals 7) bounds $ insert (16, BTree.Equals 16) bounds $ insert (85, BTree.Equals 85) bounds $ insert (63, BTree.Equals 63) bounds $ insert (42, BTree.Equals 42) bounds $ insert (98, BTree.Equals 98) bounds $ insert (25, BTree.Equals 25) bounds $ insert (73, BTree.Equals 73) bounds $ insert (36, BTree.Equals 36) bounds $ insert (1, BTree.Equals 1) bounds $ insert (62, BTree.Equals 62) bounds bg1 +-- search test +bs1 = search (BTree.Contains (34,53)) bg2 +bt1 = (sort bs1) == [36, 42, 50] +-- search test 2 +bs2 = search (BTree.Contains (43,82)) bg2 +bt2 = (sort bs2) == [50, 62, 63, 73] +-- some elements deleted +bg3 = delete (25, BTree.Equals 25) bounds $ delete (73, BTree.Equals 73) bounds $ delete (1, BTree.Equals 1) bounds bg2 +-- search test 3 +bs3 = search (BTree.Contains (20,45)) bg3 +bt3 = sort bs3 == [32, 36, 42] +-- test results +b = [bt1,bt2,bt3] + +--empty gist +rg1 = empty::GiST RTree.Predicate (Int,Int) +-- some elements added +rg2 = insert ((50,23), RTree.Equals (50,23)) bounds $ insert ((32,63), RTree.Equals (32,63)) bounds $ insert ((35,7), RTree.Equals (35,7)) bounds $ insert ((23,16), RTree.Equals (23,16)) bounds $ insert ((2,85), RTree.Equals (2,85)) bounds $ insert ((63,63), RTree.Equals (63,63)) bounds $ insert ((72,42), RTree.Equals (72,42)) bounds $ insert ((33,98), RTree.Equals (33,98)) bounds $ insert ((12,25), RTree.Equals (12,25)) bounds $ insert ((73,54), RTree.Equals (73,54)) bounds $ insert ((45,36), RTree.Equals (45,36)) bounds $ insert ((27,41), RTree.Equals (27,41)) bounds $ insert ((53,62), RTree.Equals (53,62)) bounds rg1 +-- search test 1 +rs1 = search (RTree.Contains ((12,64),(34,33))) rg2 +rt1 = (sort rs1) == [(27,41), (32,63)] +-- search test 2 +rs2 = search (RTree.Contains ((43,75),(82,33))) rg2 +rt2 = (sort rs2) == [(45,36),(53,62),(63,63), (72,42),(73,54)] +-- some elements deleted +rg3 = delete ((12,25), RTree.Equals (12,25)) bounds $ delete ((73,54), RTree.Equals (73,54)) bounds $ delete ((27,41), RTree.Equals (27,41)) bounds rg2 +-- search test 3 +rs3 = search (RTree.Contains ((20,50),(45,35))) rg3 +rt3 = sort rs3 == [(45,36)] +--test results +r = [rt1,rt2,rt3] +