diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 20d40b6..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - 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 -. \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..ae8cc53 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Johannes Schüth + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 6db2330..2faa384 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,40 @@ # JavaQuadTree -Just a simple java implementation of a quadtree +This project contains two very basic QuadTree implementation for Java. -## Usage +## Point Quad Tree +The point quad tree allows insertion of elements with provided coordinates. The quad tree will automatically subdivide when the maximum limit per cell has been reached. + +```java +// Create the quad tree with a 0,0 start coordinate and a dimension of 600x600 +PointQuadTree tree = new PointQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); + +// Store a bunch of strings with provided coordinates +tree.insert(1, 3, "1"); +tree.insert(11, 32, "2"); + +tree.insert(454, 555, "4"); +tree.insert(353, 555, "5"); +tree.insert(552, 555, "6"); +tree.insert(551, 555, "7"); + +// Locate the elements for a provided coordinate +Point target = Point.of(500, 550); +Vector> elements = tree.getElements(target); ``` -PointQuadTree tree = new PointQuadTree(new Point(0, 0), new Dimension(600, 600)); - tree.insert(1, 3, "1"); - tree.insert(11, 32, "2"); - tree.insert(11, 52, "3"); - tree.insert(454, 555, "4"); - tree.insert(353, 555, "5"); - tree.insert(552, 555, "6"); - tree.insert(551, 555, "7"); + +![PointQuadTree](examples/PointDemo.gif) + +## Spatial Quad Tree + +The spatial quad tree works a bit different. Here you don't specify the coordinates in which you want to insert the element. Instead the element dimensions will be specified. The quad tree will automatically locate a cell which can store the element with the provided size. The quad tree will automatically be subdivided to generate smaller cells if needed. + +NOTE: Please note that the current implementation does only work with element dimensions which are rectangular in shape and which have a size that is dividable by the initial quad tree dimensions. + +```java +SpatialQuadTree tree = new SpatialQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); + boolean inserted = tree.insert(Size.of(150, 150), "2"); ``` + +![SpatialQuadTree](examples/SpatialDemo.gif) \ No newline at end of file diff --git a/examples/PointDemo.gif b/examples/PointDemo.gif new file mode 100644 index 0000000..4b80cb7 Binary files /dev/null and b/examples/PointDemo.gif differ diff --git a/examples/SpatialDemo.gif b/examples/SpatialDemo.gif new file mode 100644 index 0000000..fba1028 Binary files /dev/null and b/examples/SpatialDemo.gif differ diff --git a/jreleaser.yml b/jreleaser.yml new file mode 100644 index 0000000..2089684 --- /dev/null +++ b/jreleaser.yml @@ -0,0 +1,78 @@ +project: + name: quadtree + version: 1.0.0 + versionPattern: SEMVER + + description: A point and spatial quad tree implementation for Java. + longDescription: | + A point and spatial quad tree implementation for Java. + website: https://github.com/metaloom/JavaQuadTree + authors: + - Johannes Schüth + license: Apache-2.0 + extraProperties: + inceptionYear: 2011 + +release: + github: + branch: master + username: jotschi + overwrite: true + milestone: + name: '{{projectVersion}}' + changelog: + sort: DESC + formatted: ALWAYS + format: '- {{commitShortHash}} {{commitTitle}}' + labelers: + - label: 'feature' + title: 'Resolves #' + body: 'Resolves #' + - label: 'issue' + title: 'Fixes #' + body: 'Fixes #' + - label: 'issue' + title: 'Relates to #' + body: 'Relates to #' + - label: 'task' + title: '[chore]' + - label: 'dependencies' + title: '[deps]' + - label: 'docs' + title: '[docs]' + - label: 'build' + title: '[build]' + categories: + - title: '🚀 Features' + labels: + - 'feature' + - title: '✅ Issues' + labels: + - 'issue' + - title: '🧰 Tasks' + labels: + - 'task' + - title: '📝 Documentation' + labels: + - 'docs' + - title: '⚙️ Dependencies' + labels: + - 'dependencies' + - title: 'Build' + labels: + - 'build' + hide: + categories: + - 'Build' + contributors: + - 'GitHub' + replacers: + - search: '\[chore\] ' + - search: '\[deps\] ' + - search: '\[docs\] ' + - search: '\[build\] ' + +#announce: +# twitter: +# active: release +# status: 🚀 {{projectName}} {{projectVersion}} has been released! {{releaseNotesUrl}} \ No newline at end of file diff --git a/pom.xml b/pom.xml index 96dccdb..fd52fd2 100644 --- a/pom.xml +++ b/pom.xml @@ -3,8 +3,8 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - at.jotschi - QuadTree + io.metaloom.quadtree + quadtree 1.0.0-SNAPSHOT jar @@ -14,11 +14,21 @@ 1.0.0 - QuadTree - http://maven.apache.org + quadtree + https://github.com/metaloom/JavaQuadTree + A very basic quad tree implementation + 2011 + + + scm:git:git@github.com:metaloom/JavaQuadTree.git + scm:git:git@github.com:metaloom/JavaQuadTree.git + https://github.com/metaloom/JavaQuadTree + HEAD + UTF-8 + metaloom/JavaQuadTree diff --git a/src/main/java/io/metaloom/quadtree/AbstractNode.java b/src/main/java/io/metaloom/quadtree/AbstractNode.java index 28e82c1..8ca53f2 100644 --- a/src/main/java/io/metaloom/quadtree/AbstractNode.java +++ b/src/main/java/io/metaloom/quadtree/AbstractNode.java @@ -1,6 +1,7 @@ package io.metaloom.quadtree; import java.util.Map; + import io.metaloom.quadtree.point.Point; public abstract class AbstractNode implements Node { @@ -13,20 +14,19 @@ public abstract class AbstractNode implements Node { /** * Default value for max depth */ - protected final static int MAX_DEPTH = 4; + protected final static long MAX_DEPTH = 4; protected Size bounds; protected Point startCoordinates; - protected int maxDepth; + protected long maxDepth; protected int maxElements; - protected int depth; + protected long depth; - public AbstractNode(Point startCoordinates, Size bounds, int depth) { + public AbstractNode(Point startCoordinates, Size bounds, long depth) { this(startCoordinates, bounds, depth, MAX_ELEMENTS, MAX_DEPTH); } - public AbstractNode(Point startCoordinates, Size bounds, int depth, - int maxDepth, int maxElements) { + public AbstractNode(Point startCoordinates, Size bounds, long depth, int maxElements, long maxDepth) { this.startCoordinates = startCoordinates; this.bounds = bounds; this.maxDepth = maxDepth; @@ -50,22 +50,13 @@ public int getMaxElements() { } @Override - public int getDepth() { + public long getDepth() { return depth; } @Override - public int getMaxDepth() { + public long getMaxDepth() { return maxDepth; } - @Override - public abstract void subdivide(); - - @Override - public abstract void clear(); - - @Override - public abstract Map> getSubNodes(); - } diff --git a/src/main/java/io/metaloom/quadtree/AbstractNodeElement.java b/src/main/java/io/metaloom/quadtree/AbstractNodeElement.java index 9cd2899..fe5113f 100644 --- a/src/main/java/io/metaloom/quadtree/AbstractNodeElement.java +++ b/src/main/java/io/metaloom/quadtree/AbstractNodeElement.java @@ -33,22 +33,22 @@ public T getElement() { } @Override - public int x() { + public long x() { return coordinates.x(); } @Override - public int y() { + public long y() { return coordinates.y(); } @Override - public void setX(int x) { + public void setX(long x) { coordinates.setX(x); } @Override - public void setY(int y) { + public void setY(long y) { coordinates.setY(y); } } diff --git a/src/main/java/io/metaloom/quadtree/AbstractQuadTree.java b/src/main/java/io/metaloom/quadtree/AbstractQuadTree.java index 633c627..710780b 100644 --- a/src/main/java/io/metaloom/quadtree/AbstractQuadTree.java +++ b/src/main/java/io/metaloom/quadtree/AbstractQuadTree.java @@ -22,10 +22,4 @@ public Point getStartCoordinates() { return startCoordinates; } - @Override - public abstract void clear(); - - @Override - public abstract Node getRootNode(); - } diff --git a/src/main/java/io/metaloom/quadtree/Node.java b/src/main/java/io/metaloom/quadtree/Node.java index cd7fb49..7b3e7a8 100644 --- a/src/main/java/io/metaloom/quadtree/Node.java +++ b/src/main/java/io/metaloom/quadtree/Node.java @@ -25,19 +25,30 @@ public interface Node { * * @return */ - int getDepth(); + long getDepth(); /** * Returns the max depth * * @return */ - int getMaxDepth(); + long getMaxDepth(); + /** + * Recursively clear all elements + */ void clear(); + /** + * Divide this node so that additional sub nodes can be stored. + */ void subdivide(); + /** + * Return the sub node data of this node. + * + * @return + */ Map> getSubNodes(); /** diff --git a/src/main/java/io/metaloom/quadtree/QuadTree.java b/src/main/java/io/metaloom/quadtree/QuadTree.java index 3ac64b0..d0d820e 100644 --- a/src/main/java/io/metaloom/quadtree/QuadTree.java +++ b/src/main/java/io/metaloom/quadtree/QuadTree.java @@ -36,15 +36,9 @@ public interface QuadTree { * @param point * @param size * @param element + * @return true when the element could be inserted */ - void insert(Point point, Size elementSize, T element); + boolean insert(Point point, Size elementSize, T element); - /** - * Insert the element with the given size in the next free cell - * - * @param element - * @param elementSize - */ - void insert(T element, Size elementSize); } diff --git a/src/main/java/io/metaloom/quadtree/Size.java b/src/main/java/io/metaloom/quadtree/Size.java index 1bdaba2..fd93757 100644 --- a/src/main/java/io/metaloom/quadtree/Size.java +++ b/src/main/java/io/metaloom/quadtree/Size.java @@ -3,17 +3,33 @@ import io.metaloom.quadtree.impl.SizeImpl; import io.metaloom.quadtree.point.Point; +/** + * Dimensional representation for quad trees and their elements. + */ public interface Size { - int height(); + long height(); - int width(); + long width(); + /** + * Create a new size which uses the coordinates of the point as dimensional references. + * + * @param point + * @return + */ static Size of(Point point) { return new SizeImpl(point.x(), point.y()); } - static Size of(int width, int height) { + /** + * Create a new size. + * + * @param width + * @param height + * @return + */ + static Size of(long width, long height) { return new SizeImpl(width, height); } } diff --git a/src/main/java/io/metaloom/quadtree/impl/SizeImpl.java b/src/main/java/io/metaloom/quadtree/impl/SizeImpl.java index 8a09e9b..c800b24 100644 --- a/src/main/java/io/metaloom/quadtree/impl/SizeImpl.java +++ b/src/main/java/io/metaloom/quadtree/impl/SizeImpl.java @@ -4,22 +4,26 @@ public class SizeImpl implements Size { - private final int width; - private final int height; + private final long width; + private final long height; - public SizeImpl(int width, int height) { + public SizeImpl(long width, long height) { this.width = width; this.height = height; } @Override - public int height() { + public long height() { return height; } @Override - public int width() { + public long width() { return width; } + @Override + public String toString() { + return "[" + width + ":" + height + "]"; + } } diff --git a/src/main/java/io/metaloom/quadtree/point/Point.java b/src/main/java/io/metaloom/quadtree/point/Point.java index 9b4fc72..bcac2cc 100644 --- a/src/main/java/io/metaloom/quadtree/point/Point.java +++ b/src/main/java/io/metaloom/quadtree/point/Point.java @@ -7,18 +7,31 @@ */ public interface Point { - int x(); + long x(); - int y(); + long y(); - void setX(int x); + void setX(long x); - void setY(int y); + void setY(long y); - static Point of(int x, int y) { + /** + * Create a new point with the given coordinates. + * + * @param x + * @param y + * @return + */ + static Point of(long x, long y) { return new PointImpl(x, y); } + /** + * Create a new point based on a {@link java.awt.Point} object data. + * + * @param p + * @return + */ static Point of(java.awt.Point p) { return new PointImpl(p.x, p.y); } diff --git a/src/main/java/io/metaloom/quadtree/point/PointNode.java b/src/main/java/io/metaloom/quadtree/point/PointNode.java new file mode 100644 index 0000000..0274718 --- /dev/null +++ b/src/main/java/io/metaloom/quadtree/point/PointNode.java @@ -0,0 +1,36 @@ +package io.metaloom.quadtree.point; + +import java.util.Map; +import java.util.Vector; + +import io.metaloom.quadtree.Cell; +import io.metaloom.quadtree.Node; + +public interface PointNode extends Node { + + /** + * Returns all elements for this node + * + * @return + */ + Vector> getElements(); + + /** + * Returns all elements within the cell that matches the given coordinates + * + * @param coordinates + * @return + */ + Vector> getElements(Point coordinates); + + @Override + Map> getSubNodes(); + + /** + * Insert the element into this node. If needed a subdivision will be performed + * + * @param element + * @return true when the element could be inserted + */ + boolean insert(PointNodeElement element); +} diff --git a/src/main/java/io/metaloom/quadtree/point/PointNodeElement.java b/src/main/java/io/metaloom/quadtree/point/PointNodeElement.java new file mode 100644 index 0000000..a64e4f7 --- /dev/null +++ b/src/main/java/io/metaloom/quadtree/point/PointNodeElement.java @@ -0,0 +1,7 @@ +package io.metaloom.quadtree.point; + +import io.metaloom.quadtree.NodeElement; + +public interface PointNodeElement extends NodeElement { + +} diff --git a/src/main/java/io/metaloom/quadtree/point/PointQuadTree.java b/src/main/java/io/metaloom/quadtree/point/PointQuadTree.java index ca8324a..7e84437 100644 --- a/src/main/java/io/metaloom/quadtree/point/PointQuadTree.java +++ b/src/main/java/io/metaloom/quadtree/point/PointQuadTree.java @@ -1,8 +1,9 @@ package io.metaloom.quadtree.point; +import java.util.Vector; + import io.metaloom.quadtree.QuadTree; import io.metaloom.quadtree.Size; -import io.metaloom.quadtree.point.impl.PointNode; public interface PointQuadTree extends QuadTree { @@ -13,7 +14,7 @@ public interface PointQuadTree extends QuadTree { * @param size * @param element */ - void insert(Point point, Size size, T element); + boolean insert(Point point, Size size, T element); /** * Add a new element to the QuadTree @@ -21,16 +22,18 @@ public interface PointQuadTree extends QuadTree { * @param x * @param y * @param element + * @return true when the element could be inserted */ - void insert(int x, int y, T element); + boolean insert(int x, int y, T element); /** * Add a new element to the QuadTree * * @param point * @param element + * @return true when the element could be inserted */ - void insert(Point point, T element); + boolean insert(Point point, T element); /** * Returns the rootNode of this tree @@ -38,4 +41,12 @@ public interface PointQuadTree extends QuadTree { * @return */ PointNode getRootNode(); + + /** + * Returns all elements within the cell that matches the given coordinates + * + * @param coordinates + * @return + */ + Vector> getElements(Point coordinates); } diff --git a/src/main/java/io/metaloom/quadtree/point/impl/PointImpl.java b/src/main/java/io/metaloom/quadtree/point/impl/PointImpl.java index c19396d..c510caa 100644 --- a/src/main/java/io/metaloom/quadtree/point/impl/PointImpl.java +++ b/src/main/java/io/metaloom/quadtree/point/impl/PointImpl.java @@ -4,10 +4,10 @@ public class PointImpl implements Point { - public int x; - public int y; + public long x; + public long y; - public PointImpl(int x, int y) { + public PointImpl(long x, long y) { this.x = x; this.y = y; } @@ -18,23 +18,27 @@ public PointImpl(Point point) { } @Override - public int x() { + public long x() { return x; } @Override - public int y() { + public long y() { return y; } @Override - public void setX(int x) { + public void setX(long x) { this.x = x; } @Override - public void setY(int y) { + public void setY(long y) { this.y = y; } + @Override + public String toString() { + return "[" + x + ":" + y + "]"; + } } diff --git a/src/main/java/io/metaloom/quadtree/point/impl/PointNodeElement.java b/src/main/java/io/metaloom/quadtree/point/impl/PointNodeElement.java deleted file mode 100644 index 06e1d79..0000000 --- a/src/main/java/io/metaloom/quadtree/point/impl/PointNodeElement.java +++ /dev/null @@ -1,13 +0,0 @@ -package io.metaloom.quadtree.point.impl; - - -import io.metaloom.quadtree.AbstractNodeElement; -import io.metaloom.quadtree.point.Point; - -public class PointNodeElement extends AbstractNodeElement { - - public PointNodeElement(Point coordinates, T element) { - super(coordinates, element); - } - -} diff --git a/src/main/java/io/metaloom/quadtree/point/impl/PointNodeElementImpl.java b/src/main/java/io/metaloom/quadtree/point/impl/PointNodeElementImpl.java new file mode 100644 index 0000000..887610e --- /dev/null +++ b/src/main/java/io/metaloom/quadtree/point/impl/PointNodeElementImpl.java @@ -0,0 +1,14 @@ +package io.metaloom.quadtree.point.impl; + + +import io.metaloom.quadtree.AbstractNodeElement; +import io.metaloom.quadtree.point.Point; +import io.metaloom.quadtree.point.PointNodeElement; + +public class PointNodeElementImpl extends AbstractNodeElement implements PointNodeElement { + + public PointNodeElementImpl(Point coordinates, T element) { + super(coordinates, element); + } + +} diff --git a/src/main/java/io/metaloom/quadtree/point/impl/PointNode.java b/src/main/java/io/metaloom/quadtree/point/impl/PointNodeImpl.java similarity index 54% rename from src/main/java/io/metaloom/quadtree/point/impl/PointNode.java rename to src/main/java/io/metaloom/quadtree/point/impl/PointNodeImpl.java index c58c8af..17dc60f 100644 --- a/src/main/java/io/metaloom/quadtree/point/impl/PointNode.java +++ b/src/main/java/io/metaloom/quadtree/point/impl/PointNodeImpl.java @@ -12,6 +12,8 @@ import io.metaloom.quadtree.Cell; import io.metaloom.quadtree.Size; import io.metaloom.quadtree.point.Point; +import io.metaloom.quadtree.point.PointNode; +import io.metaloom.quadtree.point.PointNodeElement; /** * This is a Node that represents each 'cell' within the quadtree. The Node will contains elements {@link AbstractNodeElement} that itself will contain the @@ -19,20 +21,22 @@ * * @param */ -public class PointNode extends AbstractNode { +public class PointNodeImpl extends AbstractNode implements PointNode { - protected static Logger log = LoggerFactory.getLogger(PointNode.class); + public static final Logger log = LoggerFactory.getLogger(PointNodeImpl.class); - protected Map> nodes = new HashMap>(); + protected Map> nodes = new HashMap<>(); /** * Holds all elements for this node */ - protected Vector> elements = new Vector>(); + protected Vector> elements = new Vector<>(); - public PointNode(Point startCoordinates, Size bounds, int depth) { + public PointNodeImpl(Point startCoordinates, Size bounds, long depth) { super(startCoordinates, bounds, depth); - log.debug("Creating new Node at depth " + depth); + if (log.isDebugEnabled()) { + log.debug("Creating new Node at depth " + depth); + } } /** @@ -43,10 +47,11 @@ public PointNode(Point startCoordinates, Size bounds, int depth) { * @param maxDepth * @param maxChildren */ - public PointNode(Point startCoordinates, Size bounds, int depth, - int maxDepth, int maxChildren) { - super(startCoordinates, bounds, depth, maxDepth, maxChildren); - log.debug("Creating new Node at depth " + depth); + public PointNodeImpl(Point startCoordinates, Size bounds, long depth, long maxDepth, int maxChildren) { + super(startCoordinates, bounds, depth, maxChildren, maxDepth); + if (log.isDebugEnabled()) { + log.debug("Creating new Node at depth " + depth); + } } /** @@ -55,7 +60,7 @@ public PointNode(Point startCoordinates, Size bounds, int depth, * @return */ public Map> getSubNodes() { - return this.nodes; + return nodes; } /** @@ -94,106 +99,93 @@ protected Cell findIndex(Point coordinates) { return index; } - /** - * Returns all elements for this node - * - * @return - */ + @Override public Vector> getElements() { return this.elements; } - /** - * Returns all elements within the cell that matches the given coordinates - * - * @param coordinates - * @return - */ + @Override public Vector> getElements(Point coordinates) { - - // Check if this node has already been subdivided. Therefor this node - // should contain no elements + // Check if this node has already been subdivided. Therefore this node should contain no elements if (nodes.size() > 0) { Cell index = findIndex(coordinates); - PointNode node = this.nodes.get(index); + PointNode node = nodes.get(index); return node.getElements(coordinates); } else { return this.elements; } } - /** - * Insert the element into this node. If needed a subdivision will be performed - * - * @param element - */ - public void insert(PointNodeElement element) { - log.debug("Inserting element into Node at depth " + depth); - // If this Node has already been subdivided just add the elements to the - // appropriate cell - if (this.nodes.size() != 0) { + @Override + public boolean insert(PointNodeElement element) { + if (log.isDebugEnabled()) { + log.debug("Inserting element into Node at depth " + depth); + } + // If this Node has already been subdivided just add the elements to the appropriate cell + if (nodes.size() != 0) { Cell index = findIndex(element); - log.debug("Inserting into existing cell: " + index); - this.nodes.get(index).insert(element); - return; + if (log.isDebugEnabled()) { + log.debug("Inserting into existing cell: " + index); + } + nodes.get(index).insert(element); + return true; } // Add the element to this node - this.elements.add(element); + elements.add(element); - // Only subdivide the node if it contain more than MAX_CHILDREN and is - // not the deepest node - if (!(this.depth >= maxDepth) && this.elements.size() > maxElements) { - this.subdivide(); + // Only subdivide the node if it contain more than MAX_CHILDREN and is not the deepest node + if (!(depth >= maxDepth) && elements.size() > maxElements) { + subdivide(); // Recall insert for each element. This will move all elements of // this node into the new nodes at the appropriate cell for (PointNodeElement current : elements) { - this.insert(current); + insert(current); } - // Remove all elements from this node since they were moved into - // subnodes - this.elements.clear(); + // Remove all elements from this node since they were moved into subnodes + elements.clear(); } - + return true; } /** * Subdivide the current node and add subnodes */ public void subdivide() { - log.debug("Subdividing node at depth " + depth); - int depth = this.depth + 1; + if (log.isDebugEnabled()) { + log.debug("Subdividing node at depth " + depth); + } + long depth = this.depth + 1; - int bx = this.startCoordinates.x(); - int by = this.startCoordinates.y(); + long bx = this.startCoordinates.x(); + long by = this.startCoordinates.y(); // Create the bounds for the new cell Size newBounds = Size.of(bounds.width() / 2, bounds.height() / 2); // Add new bounds to current start coordinates to calculate the new // start coordinates - int newXStartCoordinate = bx + newBounds.width(); - int newYStartCoordinate = by + newBounds.height(); - - PointNode cellNode = null; + long newXStartCoordinate = bx + newBounds.width(); + long newYStartCoordinate = by + newBounds.height(); // top left - cellNode = new PointNode(Point.of(bx, by), newBounds, depth, this.maxDepth, this.maxElements); - this.nodes.put(Cell.TOP_LEFT, cellNode); + PointNode tlCellNode = new PointNodeImpl(Point.of(bx, by), newBounds, depth, this.maxDepth, this.maxElements); + this.nodes.put(Cell.TOP_LEFT, tlCellNode); // top right - cellNode = new PointNode(Point.of(newXStartCoordinate, by), newBounds, depth, this.maxDepth, this.maxElements); - this.nodes.put(Cell.TOP_RIGHT, cellNode); + PointNode crCellNode = new PointNodeImpl(Point.of(newXStartCoordinate, by), newBounds, depth, this.maxDepth, this.maxElements); + this.nodes.put(Cell.TOP_RIGHT, crCellNode); // bottom left - cellNode = new PointNode(Point.of(bx, newYStartCoordinate), newBounds, depth, this.maxDepth, this.maxElements); - this.nodes.put(Cell.BOTTOM_LEFT, cellNode); + PointNode blCellNode = new PointNodeImpl(Point.of(bx, newYStartCoordinate), newBounds, depth, this.maxDepth, this.maxElements); + this.nodes.put(Cell.BOTTOM_LEFT, blCellNode); // bottom right - cellNode = new PointNode(Point.of(newXStartCoordinate, newYStartCoordinate), newBounds, depth, this.maxDepth, this.maxElements); - this.nodes.put(Cell.BOTTOM_RIGHT, cellNode); + PointNode brCellNode = new PointNodeImpl(Point.of(newXStartCoordinate, newYStartCoordinate), newBounds, depth, this.maxDepth, + this.maxElements); + this.nodes.put(Cell.BOTTOM_RIGHT, brCellNode); } /** diff --git a/src/main/java/io/metaloom/quadtree/point/impl/PointQuadTreeImpl.java b/src/main/java/io/metaloom/quadtree/point/impl/PointQuadTreeImpl.java index 426309e..2025125 100644 --- a/src/main/java/io/metaloom/quadtree/point/impl/PointQuadTreeImpl.java +++ b/src/main/java/io/metaloom/quadtree/point/impl/PointQuadTreeImpl.java @@ -5,6 +5,7 @@ import io.metaloom.quadtree.AbstractQuadTree; import io.metaloom.quadtree.Size; import io.metaloom.quadtree.point.Point; +import io.metaloom.quadtree.point.PointNodeElement; import io.metaloom.quadtree.point.PointQuadTree; /** @@ -14,7 +15,7 @@ */ public class PointQuadTreeImpl extends AbstractQuadTree implements PointQuadTree { - protected PointNode rootNode; + protected PointNodeImpl rootNode; /** * Create a new QuadTree with the give start coordinates and size @@ -24,21 +25,21 @@ public class PointQuadTreeImpl extends AbstractQuadTree implements PointQu */ public PointQuadTreeImpl(Point startCoordinates, Size size) { super(startCoordinates, size); - this.rootNode = new PointNode(startCoordinates, size, 0); + this.rootNode = new PointNodeImpl(startCoordinates, size, 0); } public PointQuadTreeImpl(Point startCoordinates, Size size, int maxDepth, int maxChildren) { super(startCoordinates, size); - this.rootNode = new PointNode(startCoordinates, size, 0, maxDepth, maxChildren); + this.rootNode = new PointNodeImpl(startCoordinates, size, 0, maxDepth, maxChildren); } @Override - public void insert(int x, int y, T element) { - insert(Point.of(x, y), element); + public boolean insert(int x, int y, T element) { + return insert(Point.of(x, y), element); } @Override - public void insert(Point point, Size size, T element) { + public boolean insert(Point point, Size size, T element) { // Check if the element coordinates are within bounds of the quadtree if (point.x() > startCoordinates.x() + size.width() || point.x() < startCoordinates.x()) { @@ -58,17 +59,12 @@ public void insert(Point point, Size size, T element) { "The y coordinate must be within bounds of [" + startCoordinates.y() + "] to [" + size.height() + "]"); } - rootNode.insert(new PointNodeElement(point, element)); + return rootNode.insert(new PointNodeElementImpl(point, element)); } @Override - public void insert(T element, Size elementSize) { - throw new RuntimeException("Not supported for point quad trees"); - } - - @Override - public void insert(Point point, T element) { + public boolean insert(Point point, T element) { // Check if the element coordinates are within bounds of the quadtree if (point.x() > startCoordinates.x() + size.width() || point.x() < startCoordinates.x()) { @@ -79,20 +75,15 @@ public void insert(Point point, T element) { "The y coordinate must be within bounds of [" + startCoordinates.y() + "] to [" + size.height() + "]"); } - rootNode.insert(new PointNodeElement(point, element)); + return rootNode.insert(new PointNodeElementImpl(point, element)); } @Override - public PointNode getRootNode() { + public PointNodeImpl getRootNode() { return rootNode; } - /** - * Returns all elements within the cell that matches the given coordinates - * - * @param coordinates - * @return - */ + @Override public Vector> getElements(Point coordinates) { return rootNode.getElements(coordinates); } diff --git a/src/main/java/io/metaloom/quadtree/spatial/SpatialNode.java b/src/main/java/io/metaloom/quadtree/spatial/SpatialNode.java index 48312cc..27bf35b 100644 --- a/src/main/java/io/metaloom/quadtree/spatial/SpatialNode.java +++ b/src/main/java/io/metaloom/quadtree/spatial/SpatialNode.java @@ -7,6 +7,11 @@ public interface SpatialNode extends Node { + /** + * Return the node element which contains the actual data object. + * + * @return + */ SpatialNodeElement getElement(); /** diff --git a/src/main/java/io/metaloom/quadtree/spatial/SpatialNodeElement.java b/src/main/java/io/metaloom/quadtree/spatial/SpatialNodeElement.java index 71134a5..61d6e68 100644 --- a/src/main/java/io/metaloom/quadtree/spatial/SpatialNodeElement.java +++ b/src/main/java/io/metaloom/quadtree/spatial/SpatialNodeElement.java @@ -4,12 +4,22 @@ public interface SpatialNodeElement extends NodeElement { - int getWidth(); + /** + * Return the width that the element consumes within the {@link SpatialQuadTree}. + * + * @return + */ + long getWidth(); - int getHeight(); + /** + * Return the height of the element that it consumes within the {@link SpatialQuadTree}. + * + * @return + */ + long getHeight(); - void setY(int y); + void setY(long y); - void setX(int x); + void setX(long x); } diff --git a/src/main/java/io/metaloom/quadtree/spatial/SpatialQuadTree.java b/src/main/java/io/metaloom/quadtree/spatial/SpatialQuadTree.java index a60feb0..6620822 100644 --- a/src/main/java/io/metaloom/quadtree/spatial/SpatialQuadTree.java +++ b/src/main/java/io/metaloom/quadtree/spatial/SpatialQuadTree.java @@ -1,6 +1,7 @@ package io.metaloom.quadtree.spatial; import io.metaloom.quadtree.QuadTree; +import io.metaloom.quadtree.Size; /** * A QuadTree that can hold the given type of elements. Each element can also have a certain dimension. @@ -9,4 +10,17 @@ */ public interface SpatialQuadTree extends QuadTree { + /** + * Return the root node of the tree. + */ + SpatialNode getRootNode(); + + /** + * Insert the element with the given size in the next free cell + * + * @param elementSize + * @param element + * @return true when the element could be inserted + */ + boolean insert(Size elementSize, T element); } diff --git a/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeElementImpl.java b/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeElementImpl.java index 6b1e8bd..e1cc72b 100644 --- a/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeElementImpl.java +++ b/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeElementImpl.java @@ -1,12 +1,10 @@ package io.metaloom.quadtree.spatial.impl; - import io.metaloom.quadtree.AbstractNodeElement; import io.metaloom.quadtree.Size; import io.metaloom.quadtree.point.Point; import io.metaloom.quadtree.spatial.SpatialNodeElement; - public class SpatialNodeElementImpl extends AbstractNodeElement implements SpatialNodeElement { protected Size elementSize; @@ -15,20 +13,24 @@ public SpatialNodeElementImpl(T element, Size elementSize) { super(element); this.elementSize = elementSize; } - + public SpatialNodeElementImpl(Point coordinates, Size elementSize, T element) { super(coordinates, element); this.elementSize = elementSize; } @Override - public int getWidth() { + public long getWidth() { return elementSize.width(); } @Override - public int getHeight() { + public long getHeight() { return elementSize.height(); } - + + @Override + public String toString() { + return "[" + elementSize + "] @ [" + x() + ":" + y() + "] => " + getElement(); + } } diff --git a/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeImpl.java b/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeImpl.java index eeace79..44c8fd4 100644 --- a/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeImpl.java +++ b/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialNodeImpl.java @@ -21,12 +21,12 @@ public class SpatialNodeImpl extends AbstractNode implements SpatialNode element; - public SpatialNodeImpl(Point startCoordinates, Size bounds, int depth) { + public SpatialNodeImpl(Point startCoordinates, Size bounds, long depth) { super(startCoordinates, bounds, depth); } - public SpatialNodeImpl(Point startCoordinates, Size bounds, int depth, int maxDepth, int maxChildren) { - super(startCoordinates, bounds, depth, maxDepth, maxChildren); + public SpatialNodeImpl(Point startCoordinates, Size bounds, long depth, long maxDepth, int maxChildren) { + super(startCoordinates, bounds, depth, maxChildren, maxDepth); } @Override @@ -45,7 +45,9 @@ public boolean insert(SpatialNodeElement insertElement) { boolean hSmaller = insertElement.getHeight() < this.getBounds().height(); boolean smaller = wSmaller && hSmaller; - log.debug("Inserting element " + insertElement.getHeight() + " - " + insertElement.getWidth()); + if (log.isDebugEnabled()) { + log.debug("Inserting element " + insertElement.getHeight() + " - " + insertElement.getWidth()); + } // Check if the element fits into this node if (fits && nodes.size() == 0) { @@ -74,6 +76,12 @@ public boolean insert(SpatialNodeElement insertElement) { } } } + if (!fits) { + if (log.isDebugEnabled()) { + log.debug( + "The node element does not fit in the bounds of this element. Most likely also subdivison did not help to find a place for it. Maybe the max depth was reached before a suitable place could be found"); + } + } return false; } @@ -86,18 +94,18 @@ public void subdivide() { if (log.isDebugEnabled()) { log.debug("Subdividing node at depth " + depth); } - int depth = this.depth + 1; + long depth = this.depth + 1; - int bx = startCoordinates.x(); - int by = startCoordinates.y(); + long bx = startCoordinates.x(); + long by = startCoordinates.y(); // Create the bounds for the new cell Size newBounds = Size.of(bounds.width() / 2, bounds.height() / 2); // Add new bounds to current start coordinates to calculate the new // start coordinates - int newXStartCoordinate = bx + newBounds.width(); - int newYStartCoordinate = by + newBounds.height(); + long newXStartCoordinate = bx + newBounds.width(); + long newYStartCoordinate = by + newBounds.height(); SpatialNodeImpl cellNode = null; @@ -139,4 +147,9 @@ public Map> getSubNodes() { return this.nodes; } + @Override + public String toString() { + return "depth: " + getDepth() + " dim:" + getBounds() + " @ " + getStartCoordinates(); + } + } diff --git a/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialQuadTreeImpl.java b/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialQuadTreeImpl.java index 456360b..c3622ac 100644 --- a/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialQuadTreeImpl.java +++ b/src/main/java/io/metaloom/quadtree/spatial/impl/SpatialQuadTreeImpl.java @@ -13,7 +13,7 @@ public class SpatialQuadTreeImpl extends AbstractQuadTree implements Spati protected static Logger log = LoggerFactory.getLogger(SpatialQuadTreeImpl.class); - protected SpatialNodeImpl rootNode; + protected SpatialNode rootNode; /** * Create a new QuadTree with the give start coordinates and size @@ -26,13 +26,19 @@ public SpatialQuadTreeImpl(Point startCoordinates, Size size) { this.rootNode = new SpatialNodeImpl(startCoordinates, size, 0); } + public SpatialQuadTreeImpl(Point startCoordinates, Size size, long maxDepth, int maxChildren) { + super(startCoordinates, size); + this.rootNode = new SpatialNodeImpl(startCoordinates, size, 0L, maxDepth, maxChildren); + } + + @Override - public void insert(T element, Size elementSize) { - rootNode.insert(new SpatialNodeElementImpl(element, elementSize)); + public boolean insert(Size elementSize, T element) { + return rootNode.insert(new SpatialNodeElementImpl(element, elementSize)); } @Override - public void insert(Point point, Size elementSize, T element) { + public boolean insert(Point point, Size elementSize, T element) { // Check if the element coordinates are within bounds of the quadtree if (point.x() > startCoordinates.x() + size.width() || point.x() < startCoordinates.x()) { @@ -55,7 +61,7 @@ public void insert(Point point, Size elementSize, T element) { + "] / [" + point.x() + elementSize.height() + "]"); } - rootNode.insert(new SpatialNodeElementImpl(point, elementSize, element)); + return rootNode.insert(new SpatialNodeElementImpl(point, elementSize, element)); } diff --git a/src/test/java/io/metaloom/quadtree/AbstractQuadTreeTest.java b/src/test/java/io/metaloom/quadtree/AbstractQuadTreeTest.java new file mode 100644 index 0000000..16463c0 --- /dev/null +++ b/src/test/java/io/metaloom/quadtree/AbstractQuadTreeTest.java @@ -0,0 +1,23 @@ +package io.metaloom.quadtree; + +import java.util.Iterator; +import java.util.Vector; +import java.util.stream.Collectors; + +import io.metaloom.quadtree.point.PointNodeElement; + +public abstract class AbstractQuadTreeTest { + + public String concat(Vector> vectorData) { + String ids = "["; + Iterator it = vectorData.stream().map(e -> e.getElement()).collect(Collectors.toList()).iterator(); + while (it.hasNext()) { + ids += it.next(); + if (it.hasNext()) { + ids += ","; + } + } + ids += "]"; + return ids; + } +} diff --git a/src/test/java/io/metaloom/quadtree/gui/QuadTreePanel.java b/src/test/java/io/metaloom/quadtree/QuadTreePanel.java similarity index 91% rename from src/test/java/io/metaloom/quadtree/gui/QuadTreePanel.java rename to src/test/java/io/metaloom/quadtree/QuadTreePanel.java index b134ce3..bb7dbd3 100644 --- a/src/test/java/io/metaloom/quadtree/gui/QuadTreePanel.java +++ b/src/test/java/io/metaloom/quadtree/QuadTreePanel.java @@ -1,4 +1,4 @@ -package io.metaloom.quadtree.gui; +package io.metaloom.quadtree; import java.awt.event.KeyEvent; import java.awt.event.KeyListener; @@ -24,14 +24,14 @@ protected QuadTreePanel() { } - protected void setupGui() { + protected void setupGui(int width, int height) { JFrame f = new JFrame(); f.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); f.addKeyListener(this); f.addMouseListener(this); f.add(this); f.setLocationRelativeTo(null); - f.setSize(700, 700); + f.setSize(width, height); f.setVisible(true); } diff --git a/src/test/java/io/metaloom/quadtree/QuadTreeTest.java b/src/test/java/io/metaloom/quadtree/QuadTreeTest.java deleted file mode 100644 index cb2b3c4..0000000 --- a/src/test/java/io/metaloom/quadtree/QuadTreeTest.java +++ /dev/null @@ -1,54 +0,0 @@ -package io.metaloom.quadtree; - -import static org.junit.Assert.assertEquals; - -import java.util.Vector; - -import org.junit.Test; - -import io.metaloom.quadtree.point.Point; -import io.metaloom.quadtree.point.impl.PointNodeElement; -import io.metaloom.quadtree.point.impl.PointQuadTreeImpl; -import io.metaloom.quadtree.spatial.impl.SpatialQuadTreeImpl; - -/** - * Unit test for simple tree setup. - */ -public class QuadTreeTest { - - @Test - public void testBasics() { - PointQuadTreeImpl tree = new PointQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); - tree.insert(1, 3, "1"); - tree.insert(11, 32, "2"); - tree.insert(11, 52, "3"); - - tree.insert(454, 555, "4"); - tree.insert(353, 555, "5"); - tree.insert(552, 555, "6"); - tree.insert(551, 555, "7"); - - Vector> elements = tree.getElements(Point.of(500, 550)); - - for (NodeElement element : elements) { - System.out.println("[" + element.x() + "-" + element.y() + "] " + element.getElement()); - } - } - - @Test - public void quadTreeBoundsTest() { - SpatialQuadTreeImpl tree = new SpatialQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); - tree.insert(Point.of(11, 3), Size.of(10, 10), "1"); - tree.insert(Point.of(22, 3), Size.of(30, 10), "2"); - tree.insert(Point.of(33, 3), Size.of(40, 10), "3"); - - } - - @Test - public void testEmptyTree() { - SpatialQuadTreeImpl tree = new SpatialQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); - assertEquals(600, tree.getSize().height()); - assertEquals(600, tree.getSize().width()); - } - -} diff --git a/src/test/java/io/metaloom/quadtree/point/PointQuadTreeTest.java b/src/test/java/io/metaloom/quadtree/point/PointQuadTreeTest.java new file mode 100644 index 0000000..c0acba0 --- /dev/null +++ b/src/test/java/io/metaloom/quadtree/point/PointQuadTreeTest.java @@ -0,0 +1,37 @@ +package io.metaloom.quadtree.point; + +import static org.junit.Assert.assertEquals; + +import org.junit.Test; + +import io.metaloom.quadtree.AbstractQuadTreeTest; +import io.metaloom.quadtree.Size; +import io.metaloom.quadtree.point.impl.PointQuadTreeImpl; + +/** + * Unit test for simple tree setup. + */ +public class PointQuadTreeTest extends AbstractQuadTreeTest { + + @Test + public void testBasics() { + PointQuadTree tree = new PointQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); + tree.insert(1, 3, "1"); + tree.insert(11, 32, "2"); + + tree.insert(454, 555, "4"); + tree.insert(353, 555, "5"); + tree.insert(552, 555, "6"); + tree.insert(551, 555, "7"); + + Point target = Point.of(500, 550); + assertEquals("[4,5,6,7]", concat(tree.getElements(target))); + + Point target2 = Point.of(0, 0); + assertEquals("[1,2]", concat(tree.getElements(target2))); + + tree.insert(11, 52, "3"); + assertEquals("[1,2,3]", concat(tree.getElements(target2))); + + } +} diff --git a/src/test/java/io/metaloom/quadtree/RenderPointQuadTree.java b/src/test/java/io/metaloom/quadtree/point/RenderPointQuadTree.java similarity index 80% rename from src/test/java/io/metaloom/quadtree/RenderPointQuadTree.java rename to src/test/java/io/metaloom/quadtree/point/RenderPointQuadTree.java index c037418..c012a6a 100644 --- a/src/test/java/io/metaloom/quadtree/RenderPointQuadTree.java +++ b/src/test/java/io/metaloom/quadtree/point/RenderPointQuadTree.java @@ -1,23 +1,27 @@ -package io.metaloom.quadtree; +package io.metaloom.quadtree.point; import java.awt.Color; import java.awt.Graphics; -import io.metaloom.quadtree.point.Point; import java.awt.event.KeyEvent; import java.awt.event.MouseEvent; import java.util.Map; import java.util.Vector; -import io.metaloom.quadtree.gui.QuadTreePanel; -import io.metaloom.quadtree.point.impl.PointNode; -import io.metaloom.quadtree.point.impl.PointNodeElement; +import io.metaloom.quadtree.Cell; +import io.metaloom.quadtree.NodeElement; +import io.metaloom.quadtree.QuadTreePanel; +import io.metaloom.quadtree.Size; +import io.metaloom.quadtree.point.Point; +import io.metaloom.quadtree.point.PointNode; +import io.metaloom.quadtree.point.PointNodeElement; +import io.metaloom.quadtree.point.PointQuadTree; import io.metaloom.quadtree.point.impl.PointQuadTreeImpl; public class RenderPointQuadTree extends QuadTreePanel { private static final long serialVersionUID = -2360219811620173423L; - protected PointQuadTreeImpl tree; + protected PointQuadTree tree; protected Vector> selectedElements = new Vector<>(); @@ -27,7 +31,7 @@ public static void main(String[] args) { protected RenderPointQuadTree() { tree = createQuadTree(); - setupGui(); + setupGui(670, 550); } /** @@ -66,10 +70,10 @@ protected void drawCells(PointNode node, Graphics g) { Size bounds = node.getBounds(); Point startCoordinates = node.getStartCoordinates(); // Draw node bounds - g.drawRect(startCoordinates.x(), startCoordinates.y(), bounds.width(), bounds.height()); + g.drawRect((int) startCoordinates.x(), (int) startCoordinates.y(), (int) bounds.width(), (int) bounds.height()); // Draw subnodes - Map> subNodes = node.getSubNodes(); + Map> subNodes = node.getSubNodes(); for (PointNode subNode : subNodes.values()) { drawCells(subNode, g); } @@ -84,7 +88,7 @@ protected void drawCells(PointNode node, Graphics g) { public void drawSelectedElements(Graphics g) { g.setColor(Color.RED); for (NodeElement element : selectedElements) { - g.drawOval(element.x() - 2, element.y() - 2, 4, 4); + g.drawOval((int) element.x() - 2, (int) element.y() - 2, 4, 4); } g.setColor(Color.BLACK); } @@ -97,8 +101,8 @@ public void drawSelectedElements(Graphics g) { public void drawElements(PointNode node, Graphics g) { Vector> elements = node.getElements(); for (PointNodeElement element : elements) { - int x = element.x(); - int y = element.y(); + int x = (int) element.x(); + int y = (int) element.y(); g.drawLine(x, y, x, y); } } @@ -119,8 +123,8 @@ public void mouseClicked(MouseEvent e) { java.awt.Point p = e.getPoint(); // Somehow my mousepoints do not match the coordinates at the window (maybe this is a xorg releated bug) - p.x -= 8; - p.y -= 30; + p.x -= 0; + p.y -= 20; if (e.getButton() == 1) { try { diff --git a/src/test/java/io/metaloom/quadtree/RenderSpatialQuadTree.java b/src/test/java/io/metaloom/quadtree/spatial/RenderSpatialQuadTree.java similarity index 78% rename from src/test/java/io/metaloom/quadtree/RenderSpatialQuadTree.java rename to src/test/java/io/metaloom/quadtree/spatial/RenderSpatialQuadTree.java index 488a76c..927e052 100644 --- a/src/test/java/io/metaloom/quadtree/RenderSpatialQuadTree.java +++ b/src/test/java/io/metaloom/quadtree/spatial/RenderSpatialQuadTree.java @@ -1,4 +1,4 @@ -package io.metaloom.quadtree; +package io.metaloom.quadtree.spatial; import java.awt.Graphics; import java.awt.Image; @@ -8,17 +8,17 @@ import javax.imageio.ImageIO; -import io.metaloom.quadtree.gui.QuadTreePanel; +import io.metaloom.quadtree.Cell; +import io.metaloom.quadtree.QuadTreePanel; +import io.metaloom.quadtree.Size; import io.metaloom.quadtree.point.Point; -import io.metaloom.quadtree.spatial.SpatialNode; -import io.metaloom.quadtree.spatial.SpatialNodeElement; import io.metaloom.quadtree.spatial.impl.SpatialQuadTreeImpl; public class RenderSpatialQuadTree extends QuadTreePanel { private static final long serialVersionUID = -7363155496742737522L; - protected SpatialQuadTreeImpl tree; + protected SpatialQuadTree tree; int untilDepth = 0; @@ -35,7 +35,7 @@ public RenderSpatialQuadTree() { } catch (IOException e) { log.error("Could not load image.", e); } - setupGui(); + setupGui(700, 700); } /** @@ -44,31 +44,31 @@ public RenderSpatialQuadTree() { * @return * @throws IOException */ - protected SpatialQuadTreeImpl createSpatialQuadTree() throws IOException { + protected SpatialQuadTree createSpatialQuadTree() throws IOException { Point startCoordinates = Point.of(100, 100); Size size = Size.of(512, 512); - SpatialQuadTreeImpl tree = new SpatialQuadTreeImpl<>(startCoordinates, size); + SpatialQuadTree tree = new SpatialQuadTreeImpl<>(startCoordinates, size); int elementSize = 32; for (int i = 0; i < 56; i++) { Size dimension = Size.of(elementSize, elementSize); - tree.insert(getRandomImage(elementSize), dimension); + tree.insert(dimension, getRandomImage(elementSize)); } elementSize = 64; for (int i = 0; i < 16; i++) { Size dimension = Size.of(elementSize, elementSize); - tree.insert(getRandomImage(elementSize), dimension); + tree.insert(dimension, getRandomImage(elementSize)); } elementSize = 128; for (int i = 0; i < 3; i++) { Size dimension = Size.of(elementSize, elementSize); - tree.insert(getRandomImage(elementSize), dimension); + tree.insert(dimension, getRandomImage(elementSize)); } elementSize = 256; for (int i = 0; i < 1; i++) { Size dimension = Size.of(elementSize, elementSize); - tree.insert(getRandomImage(elementSize), dimension); + tree.insert(dimension, getRandomImage(elementSize)); } return tree; @@ -101,7 +101,7 @@ protected void drawCells(SpatialNode node, Graphics g) { Size bounds = node.getBounds(); Point startCoordinates = node.getStartCoordinates(); // Draw node bounds - g.drawRect(startCoordinates.x(), startCoordinates.y(), bounds.width(), bounds.height()); + g.drawRect((int) startCoordinates.x(), (int) startCoordinates.y(), (int) bounds.width(), (int) bounds.height()); // Draw subnodes Map> subNodes = node.getSubNodes(); @@ -133,9 +133,8 @@ public void keyReleased(KeyEvent e) { public void drawElements(SpatialNode node, Graphics g) { SpatialNodeElement element = node.getElement(); if (element != null) { - g.drawImage(element.getElement(), element.x(), element.y(), null); + g.drawImage(element.getElement(), (int)element.x(), (int)element.y(), null); } - } } diff --git a/src/test/java/io/metaloom/quadtree/spatial/SpatialQuadTreeTest.java b/src/test/java/io/metaloom/quadtree/spatial/SpatialQuadTreeTest.java new file mode 100644 index 0000000..7e13bb5 --- /dev/null +++ b/src/test/java/io/metaloom/quadtree/spatial/SpatialQuadTreeTest.java @@ -0,0 +1,74 @@ +package io.metaloom.quadtree.spatial; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +import java.util.Map; +import java.util.Map.Entry; + +import org.junit.Test; + +import io.metaloom.quadtree.AbstractQuadTreeTest; +import io.metaloom.quadtree.Cell; +import io.metaloom.quadtree.Size; +import io.metaloom.quadtree.point.Point; +import io.metaloom.quadtree.spatial.impl.SpatialQuadTreeImpl; + +/** + * Unit test for simple tree setup. + */ +public class SpatialQuadTreeTest extends AbstractQuadTreeTest { + + @Test + public void testBasics() { + SpatialQuadTree tree = new SpatialQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); + assertTrue(tree.insert(Point.of(11, 3), Size.of(150, 150), "1")); + assertTrue(tree.insert(Point.of(22, 3), Size.of(150, 150), "2")); + assertTrue(tree.insert(Point.of(33, 3), Size.of(150, 150), "3")); + + SpatialNode root = tree.getRootNode(); + assertNotNull(root); + assertEquals("There should be always 4 sub nodes in a quad tree.", 4, root.getSubNodes().size()); + SpatialNode element = find("2", root.getSubNodes()); + assertNotNull(element); + assertEquals(2, element.getDepth()); + } + + @Test + public void testBasics2() { + SpatialQuadTree tree = new SpatialQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600), 10, 200); + assertTrue(tree.insert(Size.of(150, 150), "1")); + assertTrue(tree.insert(Size.of(150, 150), "2")); + assertTrue(tree.insert(Size.of(150, 150), "3")); + + SpatialNode root = tree.getRootNode(); + assertNotNull(root); + assertEquals("There should be always 4 sub nodes in a quad tree.", 4, root.getSubNodes().size()); + assertNotNull(find("2", root.getSubNodes())); + } + + private SpatialNode find(String id, Map> subNodes) { + for (Entry> entry : subNodes.entrySet()) { + SpatialNode v = entry.getValue(); + SpatialNodeElement data = v.getElement(); + if (data != null) { + if (id.equalsIgnoreCase(data.getElement())) { + return v; + } + } else { + return find(id, v.getSubNodes()); + } + } + return null; + } + + @Test + public void testEmptyTree() { + SpatialQuadTree tree = new SpatialQuadTreeImpl<>(Point.of(0, 0), Size.of(600, 600)); + assertEquals(600, tree.getSize().height()); + assertEquals(600, tree.getSize().width()); + assertNotNull(tree.getRootNode()); + } + +}