diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..097f9f9 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + diff --git a/.github/mergeable.yml b/.github/mergeable.yml new file mode 100644 index 0000000..5ef2f5e --- /dev/null +++ b/.github/mergeable.yml @@ -0,0 +1,20 @@ +version: 2 +mergeable: + - when: pull_request.*, pull_request_review.* + name: 'Check decoration' + validate: + - do: title + must_exclude: + regex: ^\[WIP\] + - do: description + no_empty: + enabled: true + message: Description matter and should not be empty. Provide detail with **what** was changed, **why** it was changed, and **how** it was changed. + - do: approvals + min: + count: 1 + limit: + users: + - vacmannnn + - gladiuswq + - raf-nr \ No newline at end of file diff --git a/.github/workflows/github-CI.yml b/.github/workflows/github-CI.yml new file mode 100644 index 0000000..e49559d --- /dev/null +++ b/.github/workflows/github-CI.yml @@ -0,0 +1,34 @@ +name: Run Kotlin project build with code and test coverage + +on: [push] + +jobs: + run: + strategy: + matrix: + os: [ubuntu-latest, windows-latest, macos-latest] + runs-on: ${{ matrix.os }} + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Set up JDK 17 + uses: actions/setup-java@v3 + with: + distribution: zulu + java-version: '17' + cache: gradle + + - name: Run gradle build + run: ./gradlew build + + - if: matrix.os == 'ubuntu-latest' # Container action is only supported on Linux + name: Run Test Coverage + run: ./gradlew jacocoTestReport + + - if: matrix.os == 'ubuntu-latest' + name: Jacoco Code Coverage Report + uses: cicirello/jacoco-badge-generator@v2.8.0 + with: + generate-branches-badge: true + jacoco-csv-file: app/build/jacoco/report.csv \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fe3d8af --- /dev/null +++ b/.gitignore @@ -0,0 +1,44 @@ +# Compiled class file +*.class + +# Log file +*.log + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +.gradle +**/build/ +!src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath + +# MacOS +*.DS_Store +.AppleDouble +# Ignore Gradle build output directory +build +# Ignore idea workflow files +.idea/* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..53d1f3d --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + 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 +. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..895d4d0 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Trees by team 9 +A project created to study the mechanics of AVL, Red-Black and BST trees, unit tests, databases and graphic user interface +![image](https://github.com/spbu-coding-2022/trees-9/assets/111463436/930cd060-9e55-42db-9967-cf8ff1e3081b) + + +## Navigation + +- [Download and build](#download-and-build) +- [Trees](#trees) + - [Unit tests](#unit-tests-by-junit-5) + - [Databases](#databases) +- [Authors](#authors) + +## Download and build: +Possible way to clone project by SSH key in command line: + + git clone git@github.com:spbu-coding-2022/trees-9.git + +You may build it by [gradle](https://gradle.org/): + + ./gradlew build + +To run app: + + ./gradlew run + +*Aware : build method depends on operating system* +## Trees +Implemented 3 basic tree: +- [Binary search](https://en.wikipedia.org/wiki/Binary_search_tree) tree +- [Red-Black](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree) tree +- [AVL](https://en.wikipedia.org/wiki/AVL_tree) tree + +Each tree support add, remove, find and print functions. +Node consist of **comparable** key and value +## Unit tests (by [JUnit 5](https://junit.org/junit5/)) +Tests aimed at checking different cases: +- Find existing and not existing nodes +- Add up to 10000 nodes +- Special cases of balancing +- Remove existing and not existing nodes + +For all trees, the corresponding validator is implemented + +## Databases +3 different ways to store trees: SQLite, Neo4j and .csv files + +Capability: +- Insert all nodes to tree +- Write all nodes to DB +- Delete itself + +*It's okey if*: relationships of nodes changed when the application is restarted + + +## Authors +- gladiuswq - [github](https://github.com/gladiuswq), [contact](https://t.me/gladiuswq) +- raf-nr - [github](https://github.com/raf-nr), [contact](https://t.me/nrrafik) +- vacmannnn - [github](https://github.com/vacmannnn), [contact](https://t.me/vacmannnn) diff --git a/app/build.gradle.kts b/app/build.gradle.kts new file mode 100644 index 0000000..796a886 --- /dev/null +++ b/app/build.gradle.kts @@ -0,0 +1,121 @@ +plugins { + id("org.jetbrains.kotlin.jvm") version "1.8.10" + jacoco + // Apply the application plugin to add support for building a CLI application in Java. + application + id("org.jetbrains.compose") version "1.4.0" +} + +repositories { + mavenCentral() + maven("https://maven.pkg.jetbrains.space/public/p/compose/dev") + google() +} + +dependencies { + testImplementation("org.jetbrains.kotlin:kotlin-test-junit5") + + testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.1") + + // This dependency is used by the application. + implementation ("org.apache.commons:commons-csv:1.5") + implementation("com.google.guava:guava:31.1-jre") + implementation("org.neo4j.driver", "neo4j-java-driver", "5.7.0") + testImplementation("org.junit.jupiter:junit-jupiter:5.8.1") + testImplementation("org.junit.jupiter:junit-jupiter:5.8.1") + testImplementation("org.junit.jupiter:junit-jupiter:5.8.1") + + implementation("org.xerial:sqlite-jdbc:3.41.2.1") + implementation(compose.material3) + implementation(compose.desktop.currentOs) + + // Logging + implementation("io.github.microutils:kotlin-logging-jvm:2.0.6") + implementation("org.slf4j:slf4j-simple:1.7.29") +} + +tasks.test { + finalizedBy(tasks.jacocoTestReport) + useJUnitPlatform() + testLogging { + events("passed", "skipped", "failed") + showStandardStreams = true + } + val failedTests = mutableListOf() + val skippedTests = mutableListOf() + + addTestListener (object: TestListener { + override fun beforeSuite(suite: TestDescriptor?) { } + override fun beforeTest(testDescriptor: TestDescriptor?) { } + override fun afterTest(testDescriptor: TestDescriptor, result: TestResult) { + when (result.resultType) { + TestResult.ResultType.FAILURE -> failedTests.add(testDescriptor) + TestResult.ResultType.SKIPPED -> skippedTests.add(testDescriptor) + else -> {} + } + } + override fun afterSuite(suite: TestDescriptor, result: TestResult) { + if (suite.parent == null) { // root suite + logger.lifecycle("####################################################################################") + logger.lifecycle("Test result: ${result.resultType}") + logger.lifecycle( + "Test summary: ${result.testCount} tests, " + + "${result.successfulTestCount} succeed, " + + "${result.skippedTestCount} skipped, " + + "${result.failedTestCount} failed." + ) + } + } + }) + +} + +tasks.jacocoTestReport { + dependsOn(tasks.test) + reports { + xml.required.set(true) + xml.outputLocation.set(layout.buildDirectory.file("jacoco/report.xml")) + csv.required.set(true) + csv.outputLocation.set(layout.buildDirectory.file("jacoco/report.csv")) + html.required.set(true) + html.outputLocation.set(layout.buildDirectory.dir("jacocoHtml")) + } +} + +tasks.jacocoTestCoverageVerification { + classDirectories.setFrom( classDirectories.files.flatMap { fileTree(it) { + include("**/RBBalancer.class", "**/AVLBalancer.class", "**/BINStruct", "**/AVLStruct.class", "**/BINStruct.class") + } }) + dependsOn(tasks.jacocoTestReport) + violationRules { + rule { + element = "CLASS" + limit { + counter = "BRANCH" + minimum = 0.5.toBigDecimal() + } + } + rule { + element = "CLASS" + limit { + counter = "LINE" + minimum = 0.6.toBigDecimal() + } + } + rule { + element = "CLASS" + limit { + counter = "METHOD" + minimum = 0.9.toBigDecimal() + } + } + } +} + +application { + mainClass.set("trees.AppKt") +} + +tasks.named("test") { + useJUnitPlatform() +} \ No newline at end of file diff --git a/app/src/main/kotlin/trees/AVLTree.kt b/app/src/main/kotlin/trees/AVLTree.kt new file mode 100644 index 0000000..aa52937 --- /dev/null +++ b/app/src/main/kotlin/trees/AVLTree.kt @@ -0,0 +1,110 @@ +package trees + +import trees.abstract_trees.BalanceTree +import trees.nodes.AVLNode +import kotlin.math.max + +class AVLTree, V> : BalanceTree>() { + + override fun add(key: K, value: V) { + root = recursiveAdd(root, AVLNode(key, value)) + updateHeight(root) + } + + private fun recursiveAdd(currentNode: AVLNode?, node: AVLNode): AVLNode { + if (currentNode == null) return node + if (currentNode.key < node.key) { + currentNode.right = recursiveAdd(currentNode.right, node) + } + if (currentNode.key > node.key) { + currentNode.left = recursiveAdd(currentNode.left, node) + } + if (currentNode.key == node.key) { + return node + } + return balance(currentNode) + } + + override fun remove(key: K) { + val node = find(key) ?: throw IllegalStateException("There is no such node with key $key in the tree") + root = recursiveRemove(root, node) + updateHeight(root) + } + + private fun recursiveRemove(currentNode: AVLNode?, node: AVLNode): AVLNode? { + if (currentNode == null) return null + if (currentNode.key < node.key) { + currentNode.right = recursiveRemove(currentNode.right, node) + } else if (currentNode.key > node.key) { + currentNode.left = recursiveRemove(currentNode.left, node) + } else { + if (currentNode.left == null || currentNode.right == null) + return currentNode.left ?: currentNode.right + val minRightSubtree = getMinNode(currentNode.right!!) + currentNode.key = minRightSubtree.key + currentNode.value = minRightSubtree.value + currentNode.right = recursiveRemove(currentNode.right, minRightSubtree) + } + return balance(currentNode) + } + + + override fun balance(node: AVLNode, afterRemove: Boolean): AVLNode { + updateHeight(node) + when (getBalanceFactor(node)) { + -2 -> { + if (getBalanceFactor(node.left) == 1) { + node.left = node.left?.let { rotateLeft(it) } + updateHeight(node.left) + } + val balancedNode = rotateRight(node) + updateHeight(balancedNode) + return balancedNode + } + + 2 -> { + if (getBalanceFactor(node.right) == -1) { + node.right = node.right?.let { rotateRight(it) } + updateHeight(node.right) + } + val balancedNode = rotateLeft(node) + updateHeight(balancedNode) + return balancedNode + } + } + return node + } + + internal fun getHeight(node: AVLNode?): Int { + return node?.height ?: -1 + } + + private fun getBalanceFactor(node: AVLNode?): Int { + if (node == null) return 0 + return getHeight(node.right) - getHeight(node.left) + } + + private fun updateHeight(node: AVLNode?) { + node?.let { it.height = max(getHeight(it.left), getHeight(it.right)) + 1 } + } + + private fun rotateRight(node: AVLNode): AVLNode { + val leftChild = + node.left ?: throw IllegalArgumentException("When turning right, the node must have a child on the right") + val rightGrandChild = leftChild.right + leftChild.right = node + node.left = rightGrandChild + updateHeight(leftChild.right) + return leftChild + } + + private fun rotateLeft(node: AVLNode): AVLNode { + val rightChild = + node.right ?: throw IllegalArgumentException("When turning right, the node must have a child on the right") + val leftGrandChild = rightChild.left + rightChild.left = node + node.right = leftGrandChild + updateHeight(rightChild.left) + return rightChild + } +} diff --git a/app/src/main/kotlin/trees/App.kt b/app/src/main/kotlin/trees/App.kt new file mode 100644 index 0000000..fbbdc0d --- /dev/null +++ b/app/src/main/kotlin/trees/App.kt @@ -0,0 +1,44 @@ +package trees + +import androidx.compose.runtime.getValue +import androidx.compose.runtime.mutableStateOf +import androidx.compose.runtime.remember +import androidx.compose.runtime.setValue +import androidx.compose.ui.unit.dp +import androidx.compose.ui.window.Window +import androidx.compose.ui.window.application +import androidx.compose.ui.window.rememberWindowState +import trees.gui.navigation.Screen +import trees.gui.screens.AVLScreen +import trees.gui.screens.BSTScreen +import trees.gui.screens.RBScreen +import trees.gui.screens.homeScreen +import java.awt.Dimension + +fun main() = application { + Window( + onCloseRequest = ::exitApplication, + title = "Trees by ", + state = rememberWindowState(width = 1920.dp, height = 1080.dp) + ) { + window.minimumSize = Dimension(1600, 900) + window.maximumSize = Dimension(1600, 900) + var screenState by remember { mutableStateOf(Screen.homeScreen) } + when (val screen = screenState) { + is Screen.homeScreen -> + homeScreen( + toBST = { screenState = Screen.BSTScreen }, + toAVL = { screenState = Screen.AVLScreen }, + toRB = { screenState = Screen.RBScreen }) + + is Screen.BSTScreen -> + BSTScreen(toMenu = { screenState = Screen.homeScreen}) + + is Screen.AVLScreen -> + AVLScreen(toMenu = { screenState = Screen.homeScreen}) + + is Screen.RBScreen -> + RBScreen(toMenu = { screenState = Screen.homeScreen}) + } + } +} diff --git a/app/src/main/kotlin/trees/BSTree.kt b/app/src/main/kotlin/trees/BSTree.kt new file mode 100644 index 0000000..41a4284 --- /dev/null +++ b/app/src/main/kotlin/trees/BSTree.kt @@ -0,0 +1,47 @@ +package trees + +import trees.abstract_trees.BinaryTree +import trees.nodes.BSNode + +class BSTree, V> : BinaryTree>() { + + override fun add(key: K, value: V) { + root = recursiveAdd(root, BSNode(key, value)) + } + + private fun recursiveAdd(currentNode: BSNode?, node: BSNode): BSNode { + if (currentNode == null) return node + if (currentNode.key < node.key) { + currentNode.right = recursiveAdd(currentNode.right, node) + } + if (currentNode.key > node.key) { + currentNode.left = recursiveAdd(currentNode.left, node) + } + if (currentNode.key == node.key) { + return node + } + return currentNode + } + + override fun remove(key: K) { + val node = find(key) ?: throw IllegalStateException("There is no such node with key $key in the tree") + root = recursiveRemove(root, node) + } + + private fun recursiveRemove(currentNode: BSNode?, node: BSNode): BSNode? { + if (currentNode == null) return null + if (currentNode.key < node.key) { + currentNode.right = recursiveRemove(currentNode.right, node) + } else if (currentNode.key > node.key) { + currentNode.left = recursiveRemove(currentNode.left, node) + } else { + if (currentNode.left == null || currentNode.right == null) + return currentNode.left ?: currentNode.right + val minRightSubtree = getMinNode(currentNode.right!!) + currentNode.key = minRightSubtree.key + currentNode.value = minRightSubtree.value + currentNode.right = recursiveRemove(currentNode.right, minRightSubtree) + } + return currentNode + } +} diff --git a/app/src/main/kotlin/trees/RBTree.kt b/app/src/main/kotlin/trees/RBTree.kt new file mode 100644 index 0000000..e85738f --- /dev/null +++ b/app/src/main/kotlin/trees/RBTree.kt @@ -0,0 +1,298 @@ +package trees + +import trees.abstract_trees.BalanceTree +import trees.nodes.RBNode +import trees.nodes.RBNode.Color + +class RBTree, V> : BalanceTree>() { + + override fun add(key: K, value: V) { + val node = RBNode(key, value) + + if (root == null) { + root = node + return + } + + var current = root + var parent = current + + while (current != null) { + parent = current + current = when { + current.key < node.key -> current.right + current.key > node.key -> current.left + else -> throw IllegalArgumentException("Node with key ${node.key} is already in the tree") + } + } + + if (parent == null) { + throw IllegalStateException("Only root parent can be null") + } + + if (parent.key < node.key) { + parent.right = node + } else { + parent.left = node + } + + node.parent = parent + balance(node, false) + } + + override fun remove(key: K) { + val current = find(key) ?: throw IllegalStateException("There is no such node with key $key in the tree") + + val movedUpNode: RBNode? + val deletedNodeColor: Color + + val leftSibling = current.left + val rightSibling = current.right + + if (leftSibling == null || rightSibling == null) { + movedUpNode = removeNodeWithZeroOrOneChild(current) + deletedNodeColor = current.color + } else { + val inOrderSuccessor = getMinNode(rightSibling) + current.key = inOrderSuccessor.key + deletedNodeColor = inOrderSuccessor.color + movedUpNode = removeNodeWithZeroOrOneChild(inOrderSuccessor) + } + + if (deletedNodeColor == Color.BLACK) { + if (movedUpNode == null) { + throw IllegalStateException("Incorrect tree structure") + } + balance(movedUpNode, true) + if (movedUpNode.isTemp) { + replaceParentsChild(movedUpNode.parent, movedUpNode, null) + } + } + } + + override fun balance(node: RBNode, afterRemove: Boolean): RBNode { + if (afterRemove) { + balanceAfterRemove(node) + } else { + balanceAfterAdd(node) + } + return node + } + + private fun balanceAfterAdd(node: RBNode) { + var parent = node.parent + if (parent == null || parent.color == Color.BLACK) { + return + } + + val grandparent = parent.parent + if (grandparent == null) { + parent.color = Color.BLACK + return + } + + val uncle = getUncle(parent) + if (uncle != null && uncle.color == Color.RED) { + parent.color = Color.BLACK + grandparent.color = Color.RED + uncle.color = Color.BLACK + balanceAfterAdd(grandparent) + } else if (parent == grandparent.left) { + + if (node == parent.right) { + rotateLeft(parent) + parent = node + } + + rotateRight(grandparent) + parent.color = Color.BLACK + grandparent.color = Color.RED + } else { + + if (node == parent.left) { + rotateRight(parent) + parent = node + } + + rotateLeft(grandparent) + parent.color = Color.BLACK + grandparent.color = Color.RED + } + } + + private fun balanceAfterRemove(node: RBNode) { + if (node == root) { + return + } + + val parent = node.parent + var sibling = getSibling(node) ?: throw IllegalStateException("Can't balance node with null sibling") + + if (sibling.color == Color.RED) { + handleRedSibling(node, sibling) + sibling = getSibling(node) ?: throw IllegalStateException("Incorrect node relations") + } + + if (isBlackOrNull(sibling.left) && isBlackOrNull(sibling.right)) { + sibling.color = Color.RED + if (parent == null) { + throw IllegalStateException("Only root can have null parent") + } + if (parent.color == Color.RED) { + parent.color = Color.BLACK + } else { + balanceAfterRemove(parent) + } + } else { + handleBlackRedSibling(node, sibling) + } + } + + private fun getUncle(parent: RBNode): RBNode? { + val grandparent = parent.parent + return if (grandparent?.left == parent) { + grandparent.right + } else if (grandparent?.right == parent) { + grandparent.left + } else { + throw IllegalStateException("Node with key ${parent.key} is not a child of its parent") + } + } + + private fun replaceParentsChild(parent: RBNode?, oldChild: RBNode?, newChild: RBNode?) { + if (parent == null) { + root = newChild + } else if (parent.left == oldChild) { + parent.left = newChild + } else if (parent.right == oldChild) { + parent.right = newChild + } else { + throw IllegalStateException("Node with key ${parent.key} is not a parent if its child") + } + + if (newChild != null) { + newChild.parent = parent + } + } + + private fun rotateRight(node: RBNode) { + val parent = node.parent + val leftChild = + node.left ?: throw IllegalStateException("Left child of node with key ${node.key} can't be null") + val cousin = leftChild.right + + node.left = cousin + + if (cousin != null) { + cousin.parent = node + } + + leftChild.right = node + node.parent = leftChild + + replaceParentsChild(parent, node, leftChild) + } + + private fun rotateLeft(node: RBNode) { + val parent = node.parent + val rightChild = + node.right ?: throw IllegalStateException("Right child of node with key ${node.key} can't be null") + val cousin = rightChild.left + + node.right = cousin + + if (cousin != null) { + cousin.parent = node + } + + rightChild.left = node + + node.parent = rightChild + + replaceParentsChild(parent, node, rightChild) + } + + private fun removeNodeWithZeroOrOneChild(node: RBNode): RBNode? { + return if (node.left != null) { + replaceParentsChild(node.parent, node, node.left) + node.left + } else if (node.right != null) { + replaceParentsChild(node.parent, node, node.right) + node.right + } else { + node.isTemp = true + var newChild: RBNode? = node + + if (node.color == Color.RED) { + newChild = null + } + replaceParentsChild(node.parent, node, newChild) + newChild + } + } + + private fun handleRedSibling(node: RBNode, sibling: RBNode) { + val parent = node.parent ?: throw IllegalStateException("Can't handle node with null parent") + sibling.color = Color.BLACK + parent.color = Color.RED + if (node == parent.left) { + rotateLeft(parent) + } else { + rotateRight(parent) + } + } + + private fun handleBlackRedSibling(node: RBNode?, sibling: RBNode?) { + val parent = node?.parent + if (node == null || sibling == null || parent == null) { + throw IllegalStateException("Can't handle null nodes") + } + + var mutableSibling = sibling + val nodeIsLeftChild = (node == parent.left) + if (nodeIsLeftChild && isBlackOrNull(sibling.right)) { + val tempNode = + sibling.left ?: throw IllegalStateException("Left child of node with key ${sibling.key} can't be null") + tempNode.color = Color.BLACK + sibling.color = Color.RED + rotateRight(sibling) + mutableSibling = + parent.right ?: throw IllegalStateException("Right child of node with key ${parent.key} can't be null") + } else if (!nodeIsLeftChild && isBlackOrNull(sibling.left)) { + val tempNode = sibling.right + ?: throw IllegalStateException("Right child of node with key ${sibling.key} can't be null") + tempNode.color = Color.BLACK + sibling.color = Color.RED + rotateLeft(sibling) + mutableSibling = + parent.left ?: throw IllegalStateException("Left child of node with key ${parent.key} can't be null") + } + + mutableSibling.color = parent.color + parent.color = Color.BLACK + if (nodeIsLeftChild) { + val tempNode = mutableSibling.right + ?: throw IllegalStateException("Right child of node with key ${mutableSibling.key} can't be null") + tempNode.color = Color.BLACK + rotateLeft(parent) + } else { + val tempNode = mutableSibling.left + ?: throw IllegalStateException("Left child of node with key ${parent.key} can't be null") + tempNode.color = Color.BLACK + rotateRight(parent) + } + } + + private fun getSibling(node: RBNode): RBNode? { + val parent = node.parent + return when (node) { + parent?.left -> parent.right + parent?.right -> parent.left + else -> throw IllegalStateException("Node with key ${node.key} is not a child of its parent") + } + } + + private fun isBlackOrNull(node: RBNode?): Boolean { + return node == null || node.color == Color.BLACK + } +} diff --git a/app/src/main/kotlin/trees/abstract_trees/BalanceTree.kt b/app/src/main/kotlin/trees/abstract_trees/BalanceTree.kt new file mode 100644 index 0000000..9e01fc0 --- /dev/null +++ b/app/src/main/kotlin/trees/abstract_trees/BalanceTree.kt @@ -0,0 +1,7 @@ +package trees.abstract_trees + +import trees.nodes.Node + +abstract class BalanceTree, V, NODE_TYPE : Node> : BinaryTree() { + protected abstract fun balance(node: NODE_TYPE, afterRemove: Boolean = false): NODE_TYPE +} diff --git a/app/src/main/kotlin/trees/abstract_trees/BinaryTree.kt b/app/src/main/kotlin/trees/abstract_trees/BinaryTree.kt new file mode 100644 index 0000000..986ba3c --- /dev/null +++ b/app/src/main/kotlin/trees/abstract_trees/BinaryTree.kt @@ -0,0 +1,47 @@ +package trees.abstract_trees + +import trees.nodes.Node + +abstract class BinaryTree, V, NODE_TYPE : Node> { + internal var root: NODE_TYPE? = null + + fun find(key: K): NODE_TYPE? { + var current = root + while (current != null && key != current.key) { + current = when { + current.key < key -> current.right + current.key > key -> current.left + else -> current + } + } + return current + } + + private fun recursivePrint(prefix: String, node: NODE_TYPE?, isLeft: Boolean) { + if (node == null) { + return + } + println("$prefix└──${node.key}") + var newPrefix = "$prefix " + if (isLeft) { + newPrefix = "$prefix│ " + } + recursivePrint(newPrefix, node.left, true) + recursivePrint(newPrefix, node.right, false) + } + + fun print() { + recursivePrint("", root, false) + } + + protected fun getMinNode(node: NODE_TYPE): NODE_TYPE { + var minimal = node + while (true) { + minimal = minimal.left ?: break + } + return minimal + } + + abstract fun add(key: K, value: V) + abstract fun remove(key: K) +} diff --git a/app/src/main/kotlin/trees/dataBases/AVL/SQLiteDB.kt b/app/src/main/kotlin/trees/dataBases/AVL/SQLiteDB.kt new file mode 100644 index 0000000..83efcd7 --- /dev/null +++ b/app/src/main/kotlin/trees/dataBases/AVL/SQLiteDB.kt @@ -0,0 +1,93 @@ +package main.kotlin.trees.dataBases.AVL + +import mu.KotlinLogging +import java.io.Closeable +import java.sql.* +import trees.nodes.AVLNode +import trees.AVLTree + +private val logger = KotlinLogging.logger { } +private const val DB_DRIVER = "jdbc:sqlite" + +class SQLiteDB(private val path: String) : Closeable { + private val connection = DriverManager.getConnection("$DB_DRIVER:$path") + ?: throw SQLException("Cannot connect to database") + private val addNodeStatement by lazy { connection.prepareStatement("INSERT INTO nodes(key, value) VALUES (?, ?);") } + + init { + logger.info { "Connected to database: $path" } + } + + fun open() { + connection.createStatement().also { statement -> + try { + statement.execute("CREATE TABLE IF NOT EXISTS nodes(key INTEGER NOT NULL PRIMARY KEY, value text);") + logger.info { "Tables created or already exists" } + } catch (problem: Exception) { + logger.error(problem) { "Cannot create table in database" } + } finally { + statement.close() + } + } + } + + fun addNode(node: AVLNode) { + try { + addNodeStatement.setInt(1, node.key) + addNodeStatement.setString(2, node.value) + addNodeStatement.execute() + } catch (problem: Exception) { + logger.error(problem) { "Cannot add node with key ${node.key}" } + } + } + + fun writeAllNodesToDB(node: AVLNode?, tree: AVLTree) { + val stack = mutableListOf(node?.key) + while (stack.isNotEmpty()) { + val current = stack.removeLast()?.let { tree.find(it) } + if (current?.left != null) + current.left?.key.apply(stack::add) + if (current?.right != null) + current.right?.key.apply(stack::add) + current?.let { addNode((it)) } + } + } + + fun selectNodes(): MutableList> { + val nodesList = mutableListOf>() + try { + val query = "SELECT key, value FROM nodes" + val rs = connection.createStatement().executeQuery(query) + while (rs.next()) { + val key = rs.getInt("key") + val value = rs.getString("value") + var node = AVLNode(key,value) + nodesList.add(node) + } + } catch (problem: Exception) { + logger.error(problem) { "Failed to select" } + } + return nodesList + } + + fun delete() { + connection.createStatement().also { statement -> + try { + statement.execute("DROP TABLE IF EXISTS nodes") + logger.info { "Table deleted" } + } catch (problem: Exception) { + println(problem) + logger.error(problem) { "Cannot delete table in database" } + } finally { + statement.close() + } + } + } + + override fun close() { + addNodeStatement.close() + connection.close() + logger.info { "Connection closed" } + } + +} diff --git a/app/src/main/kotlin/trees/dataBases/BST/flatFilesDB.kt b/app/src/main/kotlin/trees/dataBases/BST/flatFilesDB.kt new file mode 100644 index 0000000..2e3d75e --- /dev/null +++ b/app/src/main/kotlin/trees/dataBases/BST/flatFilesDB.kt @@ -0,0 +1,50 @@ +package trees.dataBases.BST + +import org.apache.commons.csv.CSVFormat +import org.apache.commons.csv.CSVParser +import org.apache.commons.csv.CSVPrinter +import trees.BSTree +import trees.nodes.BSNode +import java.io.File + +const val fileName = "./app/src/main/kotlin/trees/dataBases/BST/flatFile" +val curFile = File(fileName) + +fun removeFile(file: File = curFile) { + file.delete() + file.createNewFile() +} + +fun writeAllNodesToFile(node: BSNode?, tree: BSTree, file: File = File(fileName)) { + if (!file.exists()) { + file.createNewFile() + } + val stack = mutableListOf(node?.key) + file.bufferedWriter().use { + val csvPrinter = CSVPrinter(it, CSVFormat.DEFAULT) + while (stack.isNotEmpty()) { + val current = stack.removeLast()?.let {current -> tree.find(current) } + if (current?.left != null) + current.left?.key.apply(stack::add) + if (current?.right != null) + current.right?.key.apply(stack::add) + csvPrinter.printRecord("${current?.key}","${current?.value}") + } + } +} + +fun insertAllNodesToTree(file: File = curFile): BSTree { + if (!file.exists()) { + file.createNewFile() + } + val tree = BSTree() + file.bufferedReader ().use { + val csvParser = CSVParser(it, CSVFormat.DEFAULT) + for(csvRecord in csvParser) { + val nodeKey = csvRecord.get(0) + val nodeValue = csvRecord.get(1) + tree.add(nodeKey.toInt(), nodeValue) + } + } + return tree +} diff --git a/app/src/main/kotlin/trees/dataBases/RBT/Neo4jRepository.kt b/app/src/main/kotlin/trees/dataBases/RBT/Neo4jRepository.kt new file mode 100644 index 0000000..cb7faac --- /dev/null +++ b/app/src/main/kotlin/trees/dataBases/RBT/Neo4jRepository.kt @@ -0,0 +1,100 @@ +package trees.dataBases.RBT + +import org.neo4j.driver.* +import org.neo4j.driver.exceptions.SessionExpiredException +import org.neo4j.driver.exceptions.value.Uncoercible +import trees.nodes.RBNode +import java.io.Closeable +import java.io.IOException + +class Neo4jRepository: Closeable { + private var driver: Driver? = null + + fun exportRBTree(root: RBNode) { + val session = driver?.session() ?: throw IOException("Driver is not open") + session.executeWrite { tx -> + cleanDataBase(tx) + tx.run(genExportRBNodes(root)) + } + session.close() + } + + + fun importRBTree(): RBNode? { + val session = driver?.session() ?: throw IOException("Driver is not open") + val res: RBNode? = session.executeRead { tx -> + importRBNodes(tx) + } + session.close() + return res + } + + private fun cleanDataBase(tx: TransactionContext) { + tx.run("MATCH (n: RBNode) DETACH DELETE n") + } + + private fun genExportRBNodes(root: RBNode): String { + val sb = StringBuilder() + traverseExportRBNode(sb, root) + return sb.toString() + } + + private fun traverseExportRBNode( + sb: StringBuilder, + nodeView: RBNode, + ) { + sb.append( + "CREATE (:RBNode {key : \"${nodeView.key}\", " + + "value: \"${nodeView.value}\"" + ) + } + + private fun importRBNodes(tx: TransactionContext): RBNode? { + val nodeAndKeysRecords = tx.run( + "MATCH (p: RBNode)" + + "RETURN p.key AS key, p.value AS value" + ) + return parseRBNodes(nodeAndKeysRecords) + } + + private class NodeAndKeys( + val nv: RBNode, + ) + + private fun parseRBNodes(nodeAndKeysRecords: Result): RBNode? { + val key2nk = mutableMapOf() + for (nkRecord in nodeAndKeysRecords) { + try { + val key = nkRecord["key"].asInt() + val value = nkRecord["value"].asString() + val nv = RBNode(key, value) + key2nk[key] = NodeAndKeys(nv) + } catch (ex: Uncoercible) { + throw IOException("Invalid nodes label in the database", ex) + } + } + val nks = key2nk.values.toTypedArray() + if (nks.isEmpty()) { // if nodeAndKeysRecords was empty + return null + } + if (key2nk.values.size != 1) { + throw IOException("Found ${key2nk.values.size} nodes without parents in database, expected only 1 node") + } + val root = key2nk.values.first().nv + return root + } + + fun open(uri: String, username: String, password: String) { + try { + driver = GraphDatabase.driver(uri, AuthTokens.basic(username, password)) + } catch (ex: IllegalArgumentException) { + throw IOException("Wrong URI", ex) + } catch (ex: SessionExpiredException) { + throw IOException("Session failed, try restarting the app", ex) + } + } + + override fun close() { + driver?.close() + } +} \ No newline at end of file diff --git a/app/src/main/kotlin/trees/gui/model/NodeView.kt b/app/src/main/kotlin/trees/gui/model/NodeView.kt new file mode 100644 index 0000000..c70c7ce --- /dev/null +++ b/app/src/main/kotlin/trees/gui/model/NodeView.kt @@ -0,0 +1,20 @@ +package trees.gui.model + +import trees.nodes.Node + +class NodeView>(parNode: NT) { + var node = parNode + val x = 0.0 + val y = 0.0 + var left: NodeView? = null + var right: NodeView? = null + + init { + node.left?.let { + left = NodeView(it) + } + node.right?.let { + right = NodeView(it) + } + } +} diff --git a/app/src/main/kotlin/trees/gui/navigation/Screens.kt b/app/src/main/kotlin/trees/gui/navigation/Screens.kt new file mode 100644 index 0000000..9146814 --- /dev/null +++ b/app/src/main/kotlin/trees/gui/navigation/Screens.kt @@ -0,0 +1,8 @@ +package trees.gui.navigation + +sealed class Screen { + object homeScreen : Screen() + object BSTScreen : Screen() + object AVLScreen : Screen() + object RBScreen : Screen() +} diff --git a/app/src/main/kotlin/trees/gui/nodeFunctions.kt b/app/src/main/kotlin/trees/gui/nodeFunctions.kt new file mode 100644 index 0000000..301b863 --- /dev/null +++ b/app/src/main/kotlin/trees/gui/nodeFunctions.kt @@ -0,0 +1,214 @@ +package trees.gui + +import androidx.compose.foundation.background +import androidx.compose.foundation.gestures.detectDragGestures +import androidx.compose.foundation.layout.Box +import androidx.compose.foundation.layout.offset +import androidx.compose.foundation.layout.requiredSize +import androidx.compose.foundation.layout.size +import androidx.compose.foundation.shape.CircleShape +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.runtime.mutableStateOf +import androidx.compose.runtime.remember +import androidx.compose.ui.Alignment +import androidx.compose.ui.ExperimentalComposeUiApi +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.clip +import androidx.compose.ui.draw.drawBehind +import androidx.compose.ui.geometry.Offset +import androidx.compose.ui.graphics.Color +import androidx.compose.ui.input.pointer.PointerEventType +import androidx.compose.ui.input.pointer.onPointerEvent +import androidx.compose.ui.input.pointer.pointerInput +import androidx.compose.ui.unit.dp +import trees.nodes.AVLNode +import trees.nodes.BSNode +import kotlin.math.roundToInt + +fun getParent(key: Int, rootNode: BSNode): BSNode { + var current: BSNode = rootNode + while (current.left?.key != key && current.right?.key != key) { + println("${current.key} $key ${current.right?.key} ${current.left?.key}") + current = when { + current.key < key -> current.right!! + current.key > key -> current.left!! + else -> return current + } + } + return current +} + +fun getAVLParent(key: Int, rootNode: AVLNode): AVLNode { + // Functions will be merged in the future. + var current: AVLNode = rootNode + while (current.left?.key != key && current.right?.key != key) { + println("${current.key} $key ${current.right?.key} ${current.left?.key}") + current = when { + current.key < key -> current.right!! + current.key > key -> current.left!! + else -> return current + } + } + return current +} + +fun findBracketPoint(value: String): Int { + var count = 0 + for (i in value.indices) { + if (value[i] == ';') { + count++ + } + if (count == 2) { + return i + } + } + return 0 +} + +@Composable +fun printLine(start: BSNode, end: BSNode, marker: Boolean) { + //If marker is true then draw left, else draw ridth + val x0 = getX(start).dp + val y0 = getY(start).dp + val x1 = getX(end).dp + val y1 = getY(end).dp + + if (marker == true) { + Box(modifier = Modifier.offset(x0 + (0.4 * 25).dp, y0 + ((1.82*25).dp))) { + Box( + modifier = Modifier.size(x1 - x0, y1 - y0) + .drawBehind { drawLine(Color.Black, Offset.Zero, Offset((x1 - x0).toPx(), (y1 - y0).toPx()), 4f) } + ) + } + } else { + Box(modifier = Modifier.offset(x0 + (1.82*25).dp, y0 + ((1.82*25).dp))) { + Box( + modifier = Modifier.size(x1 - x0, y1 - y0) + .drawBehind { drawLine(Color.Black, Offset.Zero, Offset((x1 - x0).toPx(), (y1 - y0).toPx()), 4f) } + ) + } + } +} + +@Composable +fun printLine(start: AVLNode, end: AVLNode, marker: Boolean) { + // Functions will be merged in the future. + + //If marker is true then draw left, else draw ridth + val x0 = getX(start).dp + val y0 = getY(start).dp + val x1 = getX(end).dp + val y1 = getY(end).dp + + if (marker == true) { + Box(modifier = Modifier.offset(x0 + (0.4 * 25).dp, y0 + ((1.82*25).dp))) { + Box( + modifier = Modifier.size(x1 - x0, y1 - y0) + .drawBehind { drawLine(Color.Black, Offset.Zero, Offset((x1 - x0).toPx(), (y1 - y0).toPx()), 4f) } + ) + } + } else { + Box(modifier = Modifier.offset(x0 + (1.82*25).dp, y0 + ((1.82*25).dp))) { + Box( + modifier = Modifier.size(x1 - x0, y1 - y0) + .drawBehind { drawLine(Color.Black, Offset.Zero, Offset((x1 - x0).toPx(), (y1 - y0).toPx()), 4f) } + ) + } + } +} + +fun getX(node: BSNode): Float { + return node.value.split(";")[0].toFloat() +} + +fun getY(node: BSNode): Float { + return node.value.split(";")[1].toFloat() +} + +fun getX(node: AVLNode): Float { + // Functions will be merged in the future. + return node.value.split(";")[0].toFloat() +} + +fun getY(node: AVLNode): Float { + // Functions will be merged in the future. + return node.value.split(";")[1].toFloat() +} + +class Coordinate( + var x: Float, + var y: Float +) + +fun getCoordinate(value: String): Coordinate { + var pointerToBracket1 = 0 + var pointerToBracket2 = 0 + for (i in value.indices) { + if (value[i] == ';') { + pointerToBracket1 = i + break + } + } + for (i in pointerToBracket1 + 1 until value.length) { + if (value[i] == ';') { + pointerToBracket2 = i + break + } + } + val x = value.slice(0 until pointerToBracket1).toFloat() + val y = value.slice(pointerToBracket1 + 1 until pointerToBracket2).toFloat() + return Coordinate(x, y) +} + +fun settingValue(value: String, x: Float, y: Float, pointerToValue: Int, isNotFirst: Boolean): String { + val roundedX = (x * 1000).roundToInt() / 1000.0f + val roundedY = (y * 1000).roundToInt() / 1000.0f + if (isNotFirst) { + return roundedX.toString() + ';' + roundedY.toString() + ';' + value.slice(pointerToValue + 1 until value.length) + } else { + return "$roundedX;$roundedY;$value" + } +} + +@OptIn(ExperimentalComposeUiApi::class) +@Composable +fun printNode(node: BSNode, difColour: Boolean = false) { + var p1 = 0 + var p2 = 0 + for (i in node.value.indices) { + if (node.value[i] == ';') { + p1 = i + break + } + } + for (i in p1 + 1 until node.value.length) { + if (node.value[i] == ';') { + p2 = i + break + } + } + val coordinate = getCoordinate(node.value) + val x = remember(node.key) { mutableStateOf((coordinate.x).dp) } + val y = remember(node.key) { mutableStateOf((coordinate.y).dp) } + val valueToPrint = node.value.slice(p2 + 1 until node.value.length) + val color = if (difColour) { + Color.Green + } else { + Color.LightGray + } + Box(modifier = Modifier.offset((x.value), (y.value))) { + Box( + modifier = Modifier + .requiredSize(54.dp) + .clip(CircleShape) + .background(color) + .onPointerEvent(eventType = PointerEventType.Release) { + node.value = settingValue(node.value, x.value.value, y.value.value, p2, true) + }, + contentAlignment = Alignment.Center + ) { + Text("${node.key}") + } + } +} diff --git a/app/src/main/kotlin/trees/gui/screens/AVLScreen.kt b/app/src/main/kotlin/trees/gui/screens/AVLScreen.kt new file mode 100644 index 0000000..a74b2e5 --- /dev/null +++ b/app/src/main/kotlin/trees/gui/screens/AVLScreen.kt @@ -0,0 +1,255 @@ +package trees.gui.screens + +import androidx.compose.foundation.background +import androidx.compose.foundation.border +import androidx.compose.foundation.layout.* +import androidx.compose.foundation.shape.CircleShape +import androidx.compose.foundation.shape.RoundedCornerShape +import androidx.compose.material3.* +import androidx.compose.runtime.* +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.clip +import androidx.compose.ui.draw.shadow +import androidx.compose.ui.text.style.TextAlign +import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp +import trees.BSTree +import trees.dataBases.BST.insertAllNodesToTree +import trees.dataBases.BST.removeFile +import trees.dataBases.BST.writeAllNodesToFile +import trees.nodes.BSNode +import androidx.compose.ui.graphics.Color +import androidx.compose.ui.modifier.modifierLocalMapOf +import main.kotlin.trees.dataBases.AVL.SQLiteDB +import trees.AVLTree +import trees.gui.* +import trees.nodes.AVLNode + +@OptIn(ExperimentalMaterial3Api::class) +@Composable +fun AVLScreen(toMenu: () -> Unit) { + val db = SQLiteDB("./app/src/main/kotlin/trees/dataBases/AVL/base.db") + val tree = remember { mutableStateOf(AVLTree()) } + var textMessage by remember { mutableStateOf(mutableListOf()) } + var screenReload by remember { mutableStateOf(false) } + if (screenReload) { + screenReload = false + } + if (!treeInit) { + db.open() + var nodes = db.selectNodes() + for (i in 0..nodes.size-1) { + tree.value.add(nodes[i].key, nodes[i].value) + } + treeInit = !treeInit + } + val node = tree.value.root + val stack = mutableListOf(node?.key) + while (stack.isNotEmpty()) { + val current = stack.removeLast()?.let { current -> tree.value.find(current) } + if (current?.left != null) + current.left?.key.apply(stack::add) + if (current?.right != null) + current.right?.key.apply(stack::add) + current?.let { + val parent = tree.value.root?.let { it1 -> getAVLParent(it.key, it1) } + parent?.let { it1 -> + if (tree.value.root != it) { + if(it1.left == it) { + printLine(it1, it, true) + } else { + printLine(it1, it, false) + } + } + } + if (findMode && (enteredKey.toIntOrNull() != null) && it.key == enteredKey.toInt() && (tree.value.find( + enteredKey.toInt() + ) != null) + ) { + printNode(BSNode(it.key, it.value), true) + } else { + printNode(BSNode(it.key, it.value)) + } + } + } + Box { + Column( + Modifier.padding(10.dp, 10.dp, 0.dp, 0.dp).background(Color.Unspecified).shadow(1.dp), + verticalArrangement = Arrangement.Top, + horizontalAlignment = Alignment.Start, + ) { + Row( + verticalAlignment = Alignment.Top + ) { + Column( + verticalArrangement = Arrangement.SpaceBetween + ) { + Column( + Modifier.width(200.dp).height(150.dp).offset(0.dp, 0.dp), + verticalArrangement = Arrangement.Center, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + Button( + onClick = { + findMode = false + try { + textMessage = mutableListOf("") + var coordinate = Coordinate(850f, 0f) + var parent = AVLNode(0, "") + var value = + settingValue(enteredValue, coordinate.x + 50.0f, coordinate.y + .0f, 0, false) + var curNode = BSNode(enteredKey.toInt(), value) + tree.value.add(curNode.key, curNode.value) + if (tree.value.root?.key != enteredKey.toInt()) { + parent = getAVLParent(enteredKey.toInt(), tree.value.root!!) + coordinate = getCoordinate(parent.value) + println("${coordinate.x} ${coordinate.y}") + } + val point = findBracketPoint(value) + val offset = 85f + value = if (parent.left?.key == enteredKey.toInt()) { + settingValue(value, coordinate.x - offset, coordinate.y + offset, point, true) + } else { + settingValue(value, coordinate.x + offset, coordinate.y + offset, point, true) + } + curNode = BSNode(enteredKey.toInt(), value) + tree.value.add(curNode.key, curNode.value) + screenReload = true + } catch (_: NumberFormatException) { + textMessage = mutableListOf("Write number as a key") + } + }, + ) { + Text( + text = "Insert node", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + findMode = false + try { + textMessage = mutableListOf("") + tree.value.remove(enteredKey.toInt()) + screenReload = true + } catch (_: NumberFormatException) { + textMessage = mutableListOf("Node with this key doesn't exist") + } + }) { + Text( + text = "Remove node", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + textMessage = mutableListOf("Write key that you are looking for") + findMode = !findMode + screenReload = true + }) { + Text( + text = "Find mode", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + } + Column( + Modifier.width(200.dp).height(150.dp), + verticalArrangement = Arrangement.Center, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + Button( + onClick = { + db.open() + db.writeAllNodesToDB(tree.value.root, tree.value) +// removeFile() +// writeAllNodesToFile(tree.value.root, tree.value) + }) { + Text( + text = "Save tree", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + db.delete() + }) { + Text( + text = "Clear DB file", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + treeInit = !treeInit + toMenu() + }) { + Text( + text = "Back to menu", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + } + } + Column() { + Column( + Modifier.width(200.dp).height(260.dp).offset(25.dp, 10.dp), + verticalArrangement = Arrangement.Top, + horizontalAlignment = Alignment.Start, + ) { + val fieldsWidth = 140 + var key by remember { mutableStateOf("") } + OutlinedTextField( + modifier = Modifier + .width(fieldsWidth.dp) + .height(65.dp) + .padding(vertical = 5.dp), + value = key, + onValueChange = { + textMessage = mutableListOf("") + key = it + enteredKey = it + }, + label = { Text("Enter key", textAlign = TextAlign.Center) } + ) + var value by remember { mutableStateOf("") } + OutlinedTextField( + modifier = Modifier + .width(fieldsWidth.dp) + .height(65.dp) + .padding(vertical = 5.dp), + value = value, + onValueChange = { + value = it + enteredValue = it + }, + label = { Text("Enter value", textAlign = TextAlign.Center) } + ) + } + val text = textMessage.toString().slice(1 until textMessage.toString().length - 1) + Text( + text = text, + fontSize = 18.sp, + modifier = Modifier + .offset((10).dp, (-55).dp) + .width(150.dp), + textAlign = TextAlign.Center, + ) + } + } + } + } +} diff --git a/app/src/main/kotlin/trees/gui/screens/BSTScreen.kt b/app/src/main/kotlin/trees/gui/screens/BSTScreen.kt new file mode 100644 index 0000000..f5473c0 --- /dev/null +++ b/app/src/main/kotlin/trees/gui/screens/BSTScreen.kt @@ -0,0 +1,261 @@ +package trees.gui.screens + +import androidx.compose.foundation.border +import androidx.compose.foundation.shape.CircleShape +import androidx.compose.foundation.shape.RoundedCornerShape +import androidx.compose.material3.Button +import androidx.compose.material3.TextField +import androidx.compose.ui.draw.clip +import androidx.compose.desktop.ui.tooling.preview.Preview +import androidx.compose.foundation.background +import androidx.compose.foundation.layout.* +import androidx.compose.material3.Button +import androidx.compose.material3.ExperimentalMaterial3Api +import androidx.compose.material3.OutlinedTextField +import androidx.compose.material3.Text +import androidx.compose.runtime.* +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.shadow +import androidx.compose.ui.text.style.TextAlign +import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp +import trees.BSTree +import trees.dataBases.BST.insertAllNodesToTree +import trees.dataBases.BST.removeFile +import trees.dataBases.BST.writeAllNodesToFile +import trees.gui.* +import trees.gui.printNode +import androidx.compose.ui.graphics.Color +import androidx.compose.ui.layout.layout +import androidx.compose.ui.modifier.modifierLocalMapOf +import trees.gui.printLine +import trees.nodes.BSNode + +var treeInit = false +var findMode = false +var enteredValue: String = "" +var enteredKey: String = "" + +@OptIn(ExperimentalMaterial3Api::class) +@Preview +@Composable +fun BSTScreen(toMenu: () -> Unit) { + val tree = remember { mutableStateOf(BSTree()) } + var textMessage by remember { mutableStateOf(mutableListOf()) } + var screenReload by remember { mutableStateOf(false) } + if (screenReload) { + screenReload = false + } + if (!treeInit) { + tree.value = insertAllNodesToTree() + treeInit = !treeInit + } + val node = tree.value.root + val stack = mutableListOf(node?.key) + while (stack.isNotEmpty()) { + val current = stack.removeLast()?.let { current -> tree.value.find(current) } + if (current?.left != null) + current.left?.key.apply(stack::add) + if (current?.right != null) + current.right?.key.apply(stack::add) + current?.let { + val parent = tree.value.root?.let { it1 -> getParent(it.key, it1) } + parent?.let { it1 -> + if (tree.value.root != it) { + if(it1.left == it) { + printLine(it1, it, true) + } else { + printLine(it1, it, false) + } + } + } + if (findMode && (enteredKey.toIntOrNull() != null) && it.key == enteredKey.toInt() && (tree.value.find( + enteredKey.toInt() + ) != null) + ) { + printNode(it, true) + } else { + printNode(it) + } + } + } + var dop = 0 + Box { + Column( + Modifier.padding(10.dp, 10.dp, 0.dp, 0.dp).background(Color.Unspecified).shadow(1.dp), + verticalArrangement = Arrangement.Top, + horizontalAlignment = Alignment.Start, + ) { + Row( + verticalAlignment = Alignment.Top + ) { + Column( + verticalArrangement = Arrangement.SpaceBetween + ) { + Column( + Modifier.width(200.dp).height(150.dp).offset(0.dp, 0.dp), + verticalArrangement = Arrangement.Center, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + Button( + onClick = { + findMode = false + try { + textMessage = mutableListOf("") + var coordinate = Coordinate(850f, 0f) + var parent = BSNode(0, "") + var value = + settingValue(enteredValue, coordinate.x + 50.0f, coordinate.y + .0f, 0, false) + var curNode = BSNode(enteredKey.toInt(), value) + tree.value.add(curNode.key, curNode.value) + if (tree.value.root?.key != enteredKey.toInt()) { + parent = getParent(enteredKey.toInt(), tree.value.root!!) + coordinate = getCoordinate(parent.value) + println("${coordinate.x} ${coordinate.y}") + } + val point = findBracketPoint(value) + val offset = 85f + value = if (parent.left?.key == enteredKey.toInt()) { + settingValue(value, coordinate.x - offset, coordinate.y + offset, point, true) + } else { + settingValue(value, coordinate.x + offset, coordinate.y + offset, point, true) + } + curNode = BSNode(enteredKey.toInt(), value) + tree.value.add(curNode.key, curNode.value) + screenReload = true + } catch (_: NumberFormatException) { + textMessage = mutableListOf("Write number as a key") + } + }, + ) { + Text( + text = "Insert node", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + findMode = false + try { + textMessage = mutableListOf("") + tree.value.remove(enteredKey.toInt()) + screenReload = true + } catch (_: NumberFormatException) { + textMessage = mutableListOf("Node with this key doesn't exist") + } + }) { + Text( + text = "Remove node", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + textMessage = mutableListOf("Write key that you are looking for") + findMode = !findMode + screenReload = true + }) { + Text( + text = "Find mode", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + } + Column( + Modifier.width(200.dp).height(150.dp), + verticalArrangement = Arrangement.Center, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + Button( + onClick = { + removeFile() + writeAllNodesToFile(tree.value.root, tree.value) + }) { + Text( + text = "Save tree", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + removeFile() + }) { + Text( + text = "Clear DB file", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + treeInit = !treeInit + toMenu() + }) { + Text( + text = "Back to menu", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + } + } + Column() { + Column( + Modifier.width(200.dp).height(260.dp).offset(25.dp, 10.dp), + verticalArrangement = Arrangement.Top, + horizontalAlignment = Alignment.Start, + ) { + val fieldsWidth = 140 + var key by remember { mutableStateOf("") } + OutlinedTextField( + modifier = Modifier + .width(fieldsWidth.dp) + .height(65.dp) + .padding(vertical = 5.dp), + value = key, + onValueChange = { + textMessage = mutableListOf("") + key = it + enteredKey = it + }, + label = { Text("Enter key", textAlign = TextAlign.Center) } + ) + var value by remember { mutableStateOf("") } + OutlinedTextField( + modifier = Modifier + .width(fieldsWidth.dp) + .height(65.dp) + .padding(vertical = 5.dp), + value = value, + onValueChange = { + value = it + enteredValue = it + }, + label = { Text("Enter value", textAlign = TextAlign.Center) } + ) + } + val text = textMessage.toString().slice(1 until textMessage.toString().length - 1) + Text( + text = text, + fontSize = 18.sp, + modifier = Modifier + .offset((10).dp, (-55).dp) + .width(150.dp), + textAlign = TextAlign.Center, + ) + } + } + } + } +} diff --git a/app/src/main/kotlin/trees/gui/screens/RBScreen.kt b/app/src/main/kotlin/trees/gui/screens/RBScreen.kt new file mode 100644 index 0000000..e5b7e33 --- /dev/null +++ b/app/src/main/kotlin/trees/gui/screens/RBScreen.kt @@ -0,0 +1,133 @@ +package trees.gui.screens + +import androidx.compose.foundation.background +import androidx.compose.foundation.border +import androidx.compose.foundation.layout.* +import androidx.compose.foundation.shape.CircleShape +import androidx.compose.foundation.shape.RoundedCornerShape +import androidx.compose.material3.Button +import androidx.compose.material3.ExperimentalMaterial3Api +import androidx.compose.material3.Text +import androidx.compose.material3.TextField +import androidx.compose.runtime.* +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.clip +import androidx.compose.ui.draw.shadow +import androidx.compose.ui.text.style.TextAlign +import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp +import trees.BSTree +import trees.dataBases.BST.insertAllNodesToTree +import trees.dataBases.BST.removeFile +import trees.dataBases.BST.writeAllNodesToFile +import trees.gui.printNode +import trees.nodes.BSNode +import androidx.compose.ui.graphics.Color +import androidx.compose.ui.modifier.modifierLocalMapOf + +@OptIn(ExperimentalMaterial3Api::class) +@Composable +fun RBScreen(toMenu: () -> Unit) { + Box() { + Column( + Modifier.padding(10.dp, 10.dp, 0.dp, 0.dp).background(Color.Unspecified).shadow(1.dp), + verticalArrangement = Arrangement.Top, + horizontalAlignment = Alignment.Start, + ) { + Column( + Modifier.width(200.dp).height(300.dp).offset(0.dp, 0.dp), + verticalArrangement = Arrangement.Center, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + var key by remember { mutableStateOf("") } + TextField( + modifier = Modifier.width(180.dp).padding(vertical = 15.dp).clip(RoundedCornerShape(25.dp)), + value = key, + onValueChange = { key = it }, + label = { Text("Enter key") } + ) + var value by remember { mutableStateOf("") } + TextField( + modifier = Modifier.width(180.dp).padding(bottom = 15.dp).clip(RoundedCornerShape(25.dp)), + value = value, + onValueChange = { value = it }, + label = { Text("Enter value") } + ) + Button( + onClick = { + }, + ) { + Text( + text = "Insert node", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + }) { + Text( + text = "Remove node", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + }) { + Text( + text = "Find node", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + } + Column( + Modifier.width(200.dp).height(180.dp), + verticalArrangement = Arrangement.Center, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + Button( + onClick = { + }) { + Text( + text = "Save tree", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + }) { + Text( + text = "Clear DB file", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + toMenu() + }) { + Text( + text = "Back to menu", + modifier = Modifier.width(110.dp), + fontSize = 16.sp, + textAlign = TextAlign.Center + ) + } + } + } + Column( + Modifier.offset() + ) { + + } + } +} diff --git a/app/src/main/kotlin/trees/gui/screens/homeScreen.kt b/app/src/main/kotlin/trees/gui/screens/homeScreen.kt new file mode 100644 index 0000000..f00421a --- /dev/null +++ b/app/src/main/kotlin/trees/gui/screens/homeScreen.kt @@ -0,0 +1,66 @@ +package trees.gui.screens + +import androidx.compose.foundation.layout.Arrangement +import androidx.compose.foundation.layout.Column +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.width +import androidx.compose.material3.Button +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.text.style.TextAlign +import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp +import kotlin.system.exitProcess + +@Composable +fun homeScreen( + toBST: () -> Unit, + toAVL: () -> Unit, + toRB: () -> Unit +) { + val fontsize = 22 + val buttonWidth = 225 + Column( + Modifier.fillMaxSize(), + verticalArrangement = Arrangement.Center, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + Button(onClick = toBST) { + Text( + text = "Binary search tree", + modifier = Modifier.width(buttonWidth.dp), + fontSize = fontsize.sp, + textAlign = TextAlign.Center + ) + } + Button(onClick = toAVL) { + Text( + text = "AVL tree", + modifier = Modifier.width(buttonWidth.dp), + fontSize = fontsize.sp, + textAlign = TextAlign.Center + ) + } + Button(onClick = toRB) { + Text( + text = "Red-black tree", + modifier = Modifier.width(buttonWidth.dp), + fontSize = fontsize.sp, + textAlign = TextAlign.Center + ) + } + Button( + onClick = { + exitProcess(0) + }) { + Text( + text = "Exit", + modifier = Modifier.width(buttonWidth.dp), + fontSize = fontsize.sp, + textAlign = TextAlign.Center + ) + } + } +} diff --git a/app/src/main/kotlin/trees/nodes/AVLNode.kt b/app/src/main/kotlin/trees/nodes/AVLNode.kt new file mode 100644 index 0000000..7f26b41 --- /dev/null +++ b/app/src/main/kotlin/trees/nodes/AVLNode.kt @@ -0,0 +1,5 @@ +package trees.nodes + +class AVLNode, V>(key: K, value: V) : Node>(key, value) { + var height: Int? = 0 +} diff --git a/app/src/main/kotlin/trees/nodes/BSNode.kt b/app/src/main/kotlin/trees/nodes/BSNode.kt new file mode 100644 index 0000000..6543dad --- /dev/null +++ b/app/src/main/kotlin/trees/nodes/BSNode.kt @@ -0,0 +1,3 @@ +package trees.nodes + +class BSNode, V>(key: K, value: V) : Node>(key, value) diff --git a/app/src/main/kotlin/trees/nodes/Node.kt b/app/src/main/kotlin/trees/nodes/Node.kt new file mode 100644 index 0000000..2ad34c6 --- /dev/null +++ b/app/src/main/kotlin/trees/nodes/Node.kt @@ -0,0 +1,6 @@ +package trees.nodes + +abstract class Node, V, NODE_TYPE : Node>(var key: K, var value: V) { + var left: NODE_TYPE? = null + var right: NODE_TYPE? = null +} diff --git a/app/src/main/kotlin/trees/nodes/RBNode.kt b/app/src/main/kotlin/trees/nodes/RBNode.kt new file mode 100644 index 0000000..9669b95 --- /dev/null +++ b/app/src/main/kotlin/trees/nodes/RBNode.kt @@ -0,0 +1,13 @@ +package trees.nodes + +class RBNode, V>(key: K, value: V) : Node>(key, value) { + var parent: RBNode? = null + var color: Color = Color.RED + + enum class Color { + RED, + BLACK + } + + var isTemp: Boolean = false +} diff --git a/app/src/test/kotlin/trees/AVLTreeTest.kt b/app/src/test/kotlin/trees/AVLTreeTest.kt new file mode 100644 index 0000000..1e2df08 --- /dev/null +++ b/app/src/test/kotlin/trees/AVLTreeTest.kt @@ -0,0 +1,52 @@ +package trees + +import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.Test +import treesValidChecker.isAVLOk + +class AVLTreeTest { + private val tree = AVLTree() + + @Test + fun `find existing node`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + assertNotNull(tree.find(408)) + } + + @Test + fun `find not existing node`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + assertNull(tree.find(10001)) + } + + @Test + fun `add 10000 elements`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + assertTrue(isAVLOk()) + } + } + + @Test + fun `remove 10000 elements`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + for (i in (0..10000).shuffled()) { + tree.remove(i) + assertTrue(isAVLOk()) + } + } + + @Test + fun `remove a node that is not in tree`() { + assertThrows(IllegalStateException::class.java) { + tree.add(100, 0) + tree.remove(101) + } + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/trees/BSTreeTest.kt b/app/src/test/kotlin/trees/BSTreeTest.kt new file mode 100644 index 0000000..75ce0ba --- /dev/null +++ b/app/src/test/kotlin/trees/BSTreeTest.kt @@ -0,0 +1,52 @@ +package trees + +import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.Test +import treesValidChecker.isBstOk + +class BSTreeTest { + private val tree = BSTree() + + @Test + fun `find existing node`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + assertNotNull(tree.find(408)) + } + + @Test + fun `find not existing node`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + assertNull(tree.find(10001)) + } + + @Test + fun `add 10000 elements`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + assertTrue(isBstOk()) + } + } + + @Test + fun `remove 10000 elements`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + for (i in (0..10000).shuffled()) { + tree.remove(i) + assertTrue(isBstOk()) + } + } + + @Test + fun `remove a node that is not in tree`() { + assertThrows(IllegalStateException::class.java) { + tree.add(100, 0) + tree.remove(101) + } + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/trees/RBTreeTest.kt b/app/src/test/kotlin/trees/RBTreeTest.kt new file mode 100644 index 0000000..623168d --- /dev/null +++ b/app/src/test/kotlin/trees/RBTreeTest.kt @@ -0,0 +1,52 @@ +package trees + +import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.Test +import treesValidChecker.isRbOk + +class RBTreeTest { + private val tree = RBTree() + + @Test + fun `find existing node`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + assertNotNull(tree.find(408)) + } + + @Test + fun `find not existing node`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + assertNull(tree.find(10001)) + } + + @Test + fun `add 10000 elements`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + assertTrue(isRbOk()) + } + } + + @Test + fun `remove 10000 elements`() { + for (i in (0..10000).shuffled()) { + tree.add(i, 0) + } + for (i in (0..10000).shuffled()) { + tree.remove(i) + assertTrue(isRbOk()) + } + } + + @Test + fun `remove a node that is not in tree`() { + assertThrows(IllegalStateException::class.java) { + tree.add(100, 0) + tree.remove(101) + } + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/trees/balance/AVLBalanceTest.kt b/app/src/test/kotlin/trees/balance/AVLBalanceTest.kt new file mode 100644 index 0000000..d743e8c --- /dev/null +++ b/app/src/test/kotlin/trees/balance/AVLBalanceTest.kt @@ -0,0 +1,103 @@ +package trees.balance + +import org.junit.jupiter.api.Assertions +import org.junit.jupiter.api.Test +import trees.AVLTree + +class AVLBalanceTest { + + private val tree = AVLTree() + + @Test + fun `test method add in AVLTree (1)`() { + tree.add(10, "hello") + tree.add(8, "hello") + tree.add(6, "hello") + /* + + 10 + / 8 + 8 ---------> / \ + / 6 10 + 6 + + */ + + Assertions.assertEquals(8, tree.root?.key) + Assertions.assertEquals(6, tree.root?.left?.key) + Assertions.assertEquals(10, tree.root?.right?.key) + } + + @Test + fun `test method add in AVLTree (2)`() { + tree.add(8, "hello") + tree.add(6, "hello") + tree.add(10, "hello") + tree.add(11, "hello") + tree.add(12, "hello") + /* + 8 + / \ 8 + 6 10 / \ + \ ---------> 6 11 + 11 / \ + \ 10 12 + 12 + */ + + Assertions.assertEquals(8, tree.root?.key) + Assertions.assertEquals(6, tree.root?.left?.key) + Assertions.assertEquals(11, tree.root?.right?.key) + Assertions.assertEquals(10, tree.root?.right?.left?.key) + Assertions.assertEquals(12, tree.root?.right?.right?.key) + } + + @Test + fun `test method remove in AVLTree(remove without balance)`() { + tree.add(8, "hello") + tree.add(6, "hello") + tree.add(10, "hello") + tree.add(11, "hello") + tree.add(12, "hello") + + tree.remove(12) + /* + 8 8 + / \ / \ + 6 11 ---------> 6 11 + / \ / + 10 12 10 + + */ + + Assertions.assertEquals(8, tree.root?.key) + Assertions.assertEquals(6, tree.root?.left?.key) + Assertions.assertEquals(11, tree.root?.right?.key) + Assertions.assertEquals(10, tree.root?.right?.left?.key) + Assertions.assertEquals(null, tree.root?.right?.right?.key) + } + + @Test + fun `test method remove in AVLTree(remove with balance)`() { + tree.add(8, "hello") + tree.add(6, "hello") + tree.add(10, "hello") + tree.add(11, "hello") + tree.add(12, "hello") + + tree.remove(6) + /* + 8 11 + / \ / \ + 6 11 ---------> 8 12 + / \ \ + 10 12 10 + + */ + + Assertions.assertEquals(11, tree.root?.key) + Assertions.assertEquals(8, tree.root?.left?.key) + Assertions.assertEquals(12, tree.root?.right?.key) + Assertions.assertEquals(10, tree.root?.left?.right?.key) + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/trees/balance/BSBalanceTest.kt b/app/src/test/kotlin/trees/balance/BSBalanceTest.kt new file mode 100644 index 0000000..502b008 --- /dev/null +++ b/app/src/test/kotlin/trees/balance/BSBalanceTest.kt @@ -0,0 +1,125 @@ +package trees.balance + +import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.Test +import trees.BSTree + +class BSBalanceTest { + private val tree = BSTree() + + @Test + fun `test method add in BSTree (1)`() { + tree.add(10, "hello") + tree.add(5, "hello") + tree.add(7, "hello") + tree.add(13, "hello") + tree.add(11, "hello") + tree.add(14, "hello") + tree.add(12, "hello") + tree.add(4, "hello") + + /* + 10 + / \ + 5 13 + / \ / \ + 6 7 11 14 + \ + 12 + */ + + assertEquals(10, tree.root?.key) + assertEquals(5, tree.root?.left?.key) + assertEquals(13, tree.root?.right?.key) + assertEquals(4, tree.root?.left?.left?.key) + assertEquals(7, tree.root?.left?.right?.key) + assertEquals(14, tree.root?.right?.right?.key) + assertEquals(11, tree.root?.right?.left?.key) + assertEquals(12, tree.root?.right?.left?.right?.key) + } + + @Test + fun `test method add in BSTree (2)`() { + tree.add(10, "hello") + tree.add(9, "hello") + tree.add(8, "hello") + tree.add(7, "hello") + + /* + 10 + / + 9 + / + 8 + / + 7 + */ + + assertEquals(10, tree.root?.key) + assertEquals(9, tree.root?.left?.key) + assertEquals(null, tree.root?.right?.key) + assertEquals(8, tree.root?.left?.left?.key) + assertEquals(7, tree.root?.left?.left?.left?.key) + } + + @Test + fun `test method remove in BSTree(remove leaf)`() { + tree.add(10, "hello") + tree.add(5, "hello") + tree.add(7, "hello") + + tree.remove(7) + /* + 10 + / 10 + 5 --------> / + \ 5 + 7 + */ + + assertEquals(10, tree.root?.key) + assertEquals(5, tree.root?.left?.key) + assertEquals(null, tree.root?.left?.right?.key) + assertEquals(null, tree.root?.left?.left?.key) + } + + @Test + fun `test method remove in BSTree(remove node with one child)`() { + tree.add(10, "hello") + tree.add(5, "hello") + tree.add(7, "hello") + + tree.remove(5) + /* + 10 + / 10 + 5 --------> / + \ 7 + 7 + */ + + assertEquals(10, tree.root?.key) + assertEquals(7, tree.root?.left?.key) + assertEquals(null, tree.root?.right?.key) + assertEquals(null, tree.root?.left?.right?.key) + assertEquals(null, tree.root?.left?.left?.key) + } + + @Test + fun `test method remove in BSTree(remove node with two child)`() { + tree.add(10, "hello") + tree.add(5, "hello") + tree.add(12, "hello") + + tree.remove(10) + /* + 10 12 + / \ --------> / + 5 12 5 + */ + + assertEquals(12, tree.root?.key) + assertEquals(5, tree.root?.left?.key) + assertEquals(null, tree.root?.right?.key) + } +} \ No newline at end of file diff --git a/app/src/test/kotlin/treesValidChecker/checkers.kt b/app/src/test/kotlin/treesValidChecker/checkers.kt new file mode 100644 index 0000000..a9a7705 --- /dev/null +++ b/app/src/test/kotlin/treesValidChecker/checkers.kt @@ -0,0 +1,71 @@ +package treesValidChecker + +import trees.AVLTree +import trees.BSTree +import trees.RBTree +import trees.nodes.AVLNode +import trees.nodes.BSNode +import trees.nodes.RBNode +import kotlin.math.abs + +val BStree = BSTree() + +fun isBstOk(node: BSNode? = BStree.root): Boolean { + if (node == null) { + return true + } + if (node.left != null && node.left!!.key > node.key) { + return false + } + if (node.right != null && node.right!!.key < node.key) { + return false + } + return !(!isBstOk(node.right) || !isBstOk(node.left)) +} + +val AVLtree = AVLTree() + +fun isAVLOk(node: AVLNode? = AVLtree.root): Boolean { + if (node == null) { + return true + } + val lh = AVLtree.getHeight(node.left) + val rh = AVLtree.getHeight(node.right) + return abs(lh - rh) <= 1 && isAVLOk(node.left) && isAVLOk(node.right) +} + +val RBtree = RBTree() + +fun isRbOk(node: RBNode? = RBtree.root): Boolean { + if (node == null) { + return true + } + val blackLeft = numOfBlack(node.left) + val blackRight = numOfBlack(node.right) + return !(blackLeft != blackRight || blackLeft == -1 || !noTwoRedInARow()) +} + +fun numOfBlack(node: RBNode? = RBtree.root): Int { + if (node == null) + return 0 + val blackLeft = numOfBlack(node.left) + val blackRight = numOfBlack(node.right) + if (blackRight != blackLeft || blackLeft == -1) { + return -1 + } + if (node.color == RBNode.Color.BLACK) { + return 1 + blackLeft + } + return blackLeft +} + +fun noTwoRedInARow(node: RBNode? = RBtree.root, row: Int = 0): Boolean { + if (node == null) + return true + if (node.color == RBNode.Color.BLACK) { + return (noTwoRedInARow(node.left) && noTwoRedInARow(node.right)) + } + if (row == 1) + return false + return (noTwoRedInARow(node.left, 1) && noTwoRedInARow(node.right, 1)) +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..ccebba7 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..42defcc --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip +networkTimeout=10000 +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..79a61d4 --- /dev/null +++ b/gradlew @@ -0,0 +1,244 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..df42d93 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,18 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user manual at https://docs.gradle.org/8.0/userguide/multi_project_builds.html + */ + +rootProject.name = "trees-9" +include("app") + +pluginManagement { + repositories { + gradlePluginPortal() + maven("https://maven.pkg.jetbrains.space/public/p/compose/dev") + } +}