diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3391ef2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,5 @@ +root = true + +[*.{kt,kts}] +ktlint_code_style = intellij_idea +max_line_length = 120 \ No newline at end of file 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/.keep b/.github/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml new file mode 100644 index 0000000..6f3fa5d --- /dev/null +++ b/.github/workflows/coverage.yml @@ -0,0 +1,40 @@ +name: Coverage Test + +on: + push: +jobs: + Coverage: + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v4 + + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'oracle' + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 + + - name: Run Test Coverage + run: ./gradlew jacocoTestReport + + - name: Jacoco Test Coverage Report + uses: cicirello/jacoco-badge-generator@v2.8.0 + with: + generate-branches-badge: true + jacoco-csv-file: lib/build/jacoco/report.csv + + - name: Add coverage to PR + id: jacoco + uses: madrapps/jacoco-report@v1.6.1 + with: + paths: | + ${{ github.workspace }}/**/build/reports/jacoco/prodNormalDebugCoverage/prodNormalDebugCoverage.xml, + ${{ github.workspace }}/**/build/reports/jacoco/**/debugCoverage.xml + token: ${{ secrets.GITHUB_TOKEN }} + min-coverage-overall: 40 + update-comment: true diff --git a/.github/workflows/gradle-build.yml b/.github/workflows/gradle-build.yml new file mode 100644 index 0000000..d01a63a --- /dev/null +++ b/.github/workflows/gradle-build.yml @@ -0,0 +1,22 @@ +name: Build & Test + +on: + push: +jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, macos-latest] + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + distribution: "oracle" + java-version: '17' + + - name: Clean, Build and Test + run: ./gradlew clean build \ No newline at end of file diff --git a/.github/workflows/megalinter.yml b/.github/workflows/megalinter.yml new file mode 100644 index 0000000..685c55a --- /dev/null +++ b/.github/workflows/megalinter.yml @@ -0,0 +1,89 @@ +--- +# MegaLinter GitHub Action configuration file +# More info at https://megalinter.io +name: MegaLinter + +on: + # Trigger mega-linter at every push. Action will also be visible from Pull Requests to main + push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions) + +env: # Comment env block if you don't want to apply fixes + # Apply linter fixes configuration + APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool) + APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all) + APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request) + ENABLE_LINTERS: KOTLIN_KTLINT +concurrency: + group: ${{ github.ref }}-${{ github.workflow }} + cancel-in-progress: true + +jobs: + megalinter: + name: MegaLinter + runs-on: ubuntu-latest + permissions: + # Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR + # Remove the ones you do not need + contents: write + issues: write + pull-requests: write + steps: + # Git Checkout + - name: Checkout Code + uses: actions/checkout@v3 + with: + token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} + fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances + + # MegaLinter + - name: MegaLinter + id: ml + # You can override MegaLinter flavor used to have faster performances + # More info at https://megalinter.io/flavors/ + uses: oxsecurity/megalinter@v7 + env: + # All available variables are described in documentation + # https://megalinter.io/configuration/ + VALIDATE_ALL_CODEBASE: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY + # DISABLE: COPYPASTE,SPELL # Uncomment to disable copy-paste and spell checks + + # Upload MegaLinter artifacts + - name: Archive production artifacts + if: success() || failure() + uses: actions/upload-artifact@v4 + with: + name: MegaLinter reports + path: | + megalinter-reports + mega-linter.log + + # Create pull request if applicable (for now works only on PR from same repository, not from forks) + - name: Create Pull Request with applied fixes + id: cpr + if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix') + uses: peter-evans/create-pull-request@v6 + with: + token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} + commit-message: "[MegaLinter] Apply linters automatic fixes" + title: "[MegaLinter] Apply linters automatic fixes" + labels: bot + - name: Create PR output + if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix') + run: | + echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" + echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" + + # Push new commit if applicable (for now works only on PR from same repository, not from forks) + - name: Prepare commit + if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix') + run: sudo chown -Rc $UID .git/ + - name: Commit and push applied linter fixes + if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix') + uses: stefanzweifel/git-auto-commit-action@v4 + with: + branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }} + commit_message: "[MegaLinter] Apply linters fixes" + commit_user_name: megalinter-bot + commit_user_email: nicolas.vuillamy@ox.security \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3e8f2f6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build +/.idea/ +/megalinter-reports/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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..94eff44 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +![MegaLinter](https://github.com/spbu-coding-2023/trees-8/workflows/MegaLinter/badge.svg) +![CI_Test](https://github.com/spbu-coding-2023/trees-8/actions/workflows/CI_Test.yml/badge.svg) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![CodeFactor](https://www.codefactor.io/repository/github/spbu-coding-2023/trees-8/badge)](https://www.codefactor.io/repository/github/spbu-coding-2023/trees-8) +[![Coverage Test](https://github.com/spbu-coding-2023/trees-8/actions/workflows/coverage.yml/badge.svg)](https://github.com/spbu-coding-2023/trees-8/actions/workflows/coverage.yml) + +# Binary Trees Project + +Team #8's project on binary trees. + +## About + +Three trees are implemented in this library: [Red-Black](https://en.wikipedia.org/wiki/Red–black_tree), [AVL](https://en.wikipedia.org/wiki/AVL_tree) and [Binary Search Tree](https://en.wikipedia.org/wiki/Binary_search_tree). + +## Authors + +- [Aleksey Dmitrievtsev](https://github.com/admitrievtsev) - Red-Black Tree +- [Gleb Nasretdinov](https://github.com/Ycyken) - AVL Tree +- [Azamat Ishbaev](https://github.com/odiumuniverse) - Binary Search Tree + +## Technologies + +- Kotlin 1.9.22 +- JDK 17 +- [Gradle 8.6](https://gradle.org) + +## Library information + +Three trees are implemented, choose which one you want. +Standard methods are implemented in each tree: + ++ `set(key,value)` - Associates the specified value with the specified key in the tree. ++ `remove(key)` - Removes the specified key and its corresponding value from the tree. ++ `get(key)` - Returns the value corresponding to the given key ++ `iterator()` - Iteration by key-value pairs in order of keys + +There are also many others methods: + ++ `setIfAbsent(key,value)` ++ `getOrDefault(key, defaultValue)` ++ `getOrSet(key,defaultValue)` ++ `min()` ++ `max()` ++ `isEmpty()` ++ `isNotEmpty()` ++ `containsKey(key)` ++ `clear()` + +AVL and Red-Black trees are self-balancing + +### Suggestions and wishes + +Suggestions can be made in code review or [Issues](https://github.com/spbu-coding-2023/trees-8/issues) on GitHub + +### Licence + +The library is distributed under the [GNU GPLv3 licence](https://www.gnu.org/licenses/gpl-3.0.html) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..d4d7e1f --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,15 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format + +[versions] +commons-math3 = "3.6.1" +guava = "32.1.3-jre" +junit-jupiter-engine = "5.10.0" + +[libraries] +commons-math3 = { module = "org.apache.commons:commons-math3", version.ref = "commons-math3" } +guava = { module = "com.google.guava:guava", version.ref = "guava" } +junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit-jupiter-engine" } + +[plugins] +jvm = { id = "org.jetbrains.kotlin.jvm", version = "1.9.20" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 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..a80b22c --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/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##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# 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 + if ! command -v java >/dev/null 2>&1 + then + 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 +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=SC2039,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=SC2039,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 + + +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +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..25da30d --- /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. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +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/lib/build.gradle.kts b/lib/build.gradle.kts new file mode 100644 index 0000000..8b95e8b --- /dev/null +++ b/lib/build.gradle.kts @@ -0,0 +1,70 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This generated file contains a sample Kotlin library project to get you started. + * For more details on building Java & JVM projects, please refer to https://docs.gradle.org/8.6/userguide/building_java_projects.html in the Gradle documentation. + */ + +plugins { + // Apply the org.jetbrains.kotlin.jvm Plugin to add support for Kotlin. + alias(libs.plugins.jvm) + + // Apply the java-library plugin for API and implementation separation. + `java-library` + jacoco + `jacoco-report-aggregation` +} + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() +} + +dependencies { + // Use the Kotlin JUnit 5 integration. + testImplementation("org.jetbrains.kotlin:kotlin-test-junit5") + + // Use the JUnit 5 integration. + testImplementation(libs.junit.jupiter.engine) + + testRuntimeOnly("org.junit.platform:junit-platform-launcher") + + // This dependency is exported to consumers, that is to say found on their compile classpath. + api(libs.commons.math3) + + // This dependency is used internally, and not exposed to consumers on their own compile classpath. + implementation(libs.guava) +} + +// Apply a specific Java toolchain to ease working on different environments. +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +tasks.named("test") { + // Use JUnit Platform for unit tests. + useJUnitPlatform() +} + +tasks.test { + finalizedBy(tasks.jacocoTestReport) +} +tasks.jacocoTestReport { + dependsOn(tasks.test) +} + +jacoco { + toolVersion = "0.8.11" + reportsDirectory = layout.buildDirectory.dir("lib/build/jacoco").get().asFile +} + +tasks.jacocoTestReport { + reports { + xml.required = true + csv.required = true + html.outputLocation = layout.buildDirectory.dir("jacocoHtml").get().asFile + csv.outputLocation = layout.buildDirectory.file("jacoco/report.csv") + } +} diff --git a/lib/src/main/kotlin/trees/abstracts/BSTree.kt b/lib/src/main/kotlin/trees/abstracts/BSTree.kt new file mode 100644 index 0000000..23f384f --- /dev/null +++ b/lib/src/main/kotlin/trees/abstracts/BSTree.kt @@ -0,0 +1,196 @@ +package trees.abstracts + +import java.util.Stack + +abstract class BSTree, V, Vertex_t : Vertex> { + internal var root: Vertex_t? = null + var size: Int = 0 + protected set(value) { + if (value >= 0) { + field = value + } else { + throw IllegalArgumentException("Tree size cannot be a negative number") + } + } + + /** + * Associates the specified [value] with the specified [key] in the tree. + * + * @return the previous value associated with the key, or `null` if the key was not present in the tree. + */ + abstract operator fun set(key: K, value: V): V? + + protected abstract fun createVertex(key: K, value: V): Vertex_t + + /** + * Set specified value by specified key + * + * Returns: a pair of set vertex and old value. + * If key didn't exist, the returned value is null. + */ + protected fun setWithoutBalance(key: K, value: V): Pair { + if (root == null) { + val newVertex = createVertex(key, value) + root = newVertex + return Pair(newVertex, null) + } + + var cur = root ?: throw IllegalStateException("Case when root is null is processed above") + while (true) { + val result = key.compareTo(cur.key) + if (result < 0) { + if (cur.left == null) { + val newVertex = createVertex(key, value) + cur.left = newVertex + newVertex.parent = cur + return Pair(newVertex, null) + } + cur = cur.left ?: throw IllegalStateException("Case when cur.left is null is processed above") + } else if (result > 0) { + if (cur.right == null) { + val newVertex = createVertex(key, value) + cur.right = newVertex + newVertex.parent = cur + return Pair(newVertex, null) + } + cur = cur.right ?: throw IllegalStateException("Case when cur.right is null is processed above") + } else { + val oldValue = cur.value + cur.value = value + return Pair(cur, oldValue) + } + } + } + + /** + * Associates the specified value with the specified key if this key is not in the tree. + * @return true if this key is not in the tree, otherwise false + */ + fun setIfAbsent(key: K, value: V): Boolean { + if (get(key) == null) { + set(key, value) + return true + } + return false + } + + /** + * Returns the value corresponding to the given [key], or `null` if such a key is not present in the tree. + */ + operator fun get(key: K): V? { + return vertByKey(key)?.value + } + + /** + * Returns the value corresponding to the given [key], or [defaultValue] if such a key is not present in the map. + */ + fun getOrDefault(key: K, defaultValue: Any): Any { + return get(key) ?: defaultValue + } + + /** + * Returns the value for the given [key] if the value is present and not `null`. + * Otherwise, calls the [set] function, + * set [defaultValue] into the tree under the given key and returns null. + */ + fun getOrSet(key: K, defaultValue: V): V? { + return get(key) ?: set(key, defaultValue) + } + + /** + * Removes the specified key and its corresponding value from the tree. + * + * @return the previous value associated with the key, or `null` if the key was not present in the map. + */ + abstract fun remove(key: K): V? + + operator fun iterator(): TreeIterator { + return TreeIterator() + } + + inner class TreeIterator : Iterator> { + private var cur = root + private val stack = Stack() + + override fun next(): Pair { + while (hasNext()) { + if (cur != null) { + cur?.let { + stack.push(it) + cur = it.left + } + } else { + val returnVert = stack.pop() + cur = returnVert.right + return returnVert.toPair() + } + } + throw IndexOutOfBoundsException() + } + + override fun hasNext(): Boolean { + return stack.isNotEmpty() or (cur != null) + } + } + + /** + * Returns Pair by minimum key in the tree. If tree is empty then returns null + */ + fun min(): Pair? { + return minVertex(root)?.toPair() + } + + protected fun minVertex(vertex: Vertex_t?): Vertex_t? { + var cur = vertex + while (cur?.left != null) { + cur = cur.left + } + return cur + } + + protected fun maxVertex(vertex: Vertex_t?): Vertex_t? { + var cur = vertex + while (cur?.right != null) { + cur = cur.right + } + return cur + } + + /** + * Returns Pair by maximum key in the tree. If tree is empty then returns null + */ + fun max(): Pair? { + return maxVertex(root)?.toPair() + } + + protected fun vertByKey(key: K): Vertex_t? { + var cur = root + while (cur != null) { + if (key < cur.key) { + cur = cur.left + } else if (key > cur.key) { + cur = cur.right + } else if (key == cur.key) { + break + } + } + return cur + } + + fun isEmpty(): Boolean { + return size == 0 + } + + fun isNotEmpty(): Boolean { + return size != 0 + } + + fun containsKey(key: K): Boolean { + return get(key) != null + } + + fun clear() { + size = 0 + root = null + } +} diff --git a/lib/src/main/kotlin/trees/abstracts/BalanceBSTree.kt b/lib/src/main/kotlin/trees/abstracts/BalanceBSTree.kt new file mode 100644 index 0000000..fcb7404 --- /dev/null +++ b/lib/src/main/kotlin/trees/abstracts/BalanceBSTree.kt @@ -0,0 +1,4 @@ +package trees.abstracts + +abstract class BalanceBSTree, V, Vertex_t : Vertex> : + BSTree() diff --git a/lib/src/main/kotlin/trees/abstracts/Vertex.kt b/lib/src/main/kotlin/trees/abstracts/Vertex.kt new file mode 100644 index 0000000..0417f41 --- /dev/null +++ b/lib/src/main/kotlin/trees/abstracts/Vertex.kt @@ -0,0 +1,22 @@ +package trees.abstracts + +abstract class Vertex, V, Vertex_t : Vertex>(key: K, value: V) { + var key = key + internal set + var value = value + internal set + var parent: Vertex_t? = null + internal set + var left: Vertex_t? = null + internal set + var right: Vertex_t? = null + internal set + + operator fun compareTo(other: Vertex): Int { + return key.compareTo(other.key) + } + + fun toPair(): Pair { + return Pair(key, value) + } +} diff --git a/lib/src/main/kotlin/trees/implementations/AvlTree.kt b/lib/src/main/kotlin/trees/implementations/AvlTree.kt new file mode 100644 index 0000000..d8c1b97 --- /dev/null +++ b/lib/src/main/kotlin/trees/implementations/AvlTree.kt @@ -0,0 +1,264 @@ +package trees.implementations + +import trees.abstracts.BalanceBSTree + +class AvlTree, V> : BalanceBSTree>() { + override operator fun set(key: K, value: V): V? { + val (currentVert, oldValue) = setWithoutBalance(key, value) + if (oldValue == null) { + size += 1 + balanceAfterSet(currentVert) + } + return oldValue + } + + override fun createVertex(key: K, value: V): AVLVertex { + return AVLVertex(key, value) + } + + /** + * Climbing up the tree, updates diffHeights of vertices after set and calls + * [balanceOnce] if vertex became unbalanced + */ + private fun balanceAfterSet(vertex: AVLVertex) { + var cur = vertex + while (cur.parent != null) { + val prevKey = cur.key + cur = cur.parent ?: throw IllegalStateException("Parent can't be null due to while condition") + if (prevKey == cur.left?.key) { + cur.diffHeight += 1 + } else if (prevKey == cur.right?.key) { + cur.diffHeight -= 1 + } + + cur = balanceOnce(cur) + if (cur.diffHeight == 0) break + } + } + + override fun remove(key: K): V? { + val toRemove = vertByKey(key) ?: return null + val oldValue = toRemove.value + removeVert(toRemove) + size -= 1 + return oldValue + } + + /** + * Removes specified vertex and balances the tree + */ + private fun removeVert(toRemove: AVLVertex) { + val parent = toRemove.parent + if (toRemove.left == null && toRemove.right == null) { + when { + parent == null -> root = null + + parent.left == toRemove -> { + parent.left = null + parent.diffHeight -= 1 + } + + parent.right == toRemove -> { + parent.right = null + parent.diffHeight += 1 + } + } + balanceAfterRemove(parent) + } else if (toRemove.right == null) { + toRemove.left?.let { + toRemove.key = it.key + toRemove.value = it.value + toRemove.left = null + toRemove.diffHeight = 0 + } + balanceAfterRemove(parent) + when { + parent?.left == toRemove -> parent.diffHeight -= 1 + parent?.right == toRemove -> parent.diffHeight += 1 + } + } else { + val minRight = + minVertex(toRemove.right) + ?: throw IllegalStateException("min of subtree can't be null if it's contains at least one element") + toRemove.key = minRight.key + toRemove.value = minRight.value + removeVert(minRight) + } + } + + /** + * Climbing up the tree, updates diffHeights of vertices after remove and calls + * [balanceOnce] if vertex became unbalanced + */ + private fun balanceAfterRemove(vertex: AVLVertex?) { + var cur = vertex ?: return + while (cur.diffHeight != 1 && cur.diffHeight != -1) { + cur = balanceOnce(cur) + if (cur.diffHeight != 1 && cur.diffHeight != -1) { + when { + cur.parent?.left == cur -> cur.parent?.let { it.diffHeight -= 1 } + cur.parent?.right == cur -> cur.parent?.let { it.diffHeight += 1 } + } + } + cur = cur.parent ?: return + } + } + + private fun getDiffHeight(vertex: AVLVertex?): Int { + return vertex?.diffHeight ?: 0 + } + + /** + * Balances subtree by specified root, updates diffHeights of vertices + * @return new root of subtree + */ + private fun balanceOnce(_vertex: AVLVertex): AVLVertex { + var vertex = _vertex + if (vertex.diffHeight == 2) { + if (getDiffHeight(vertex.left) >= 0) { + vertex = rotateRight(vertex) + } else if (getDiffHeight(vertex.left) == -1) { + vertex.left?.let { + vertex.left = rotateLeft(it) + vertex = rotateRight(vertex) + } + } + } else if (vertex.diffHeight == -2) { + if (getDiffHeight(vertex.right) <= 0) { + vertex = rotateLeft(vertex) + } else if (getDiffHeight(vertex.right) == 1) { + vertex.right?.let { + rotateRight(it) + vertex = rotateLeft(vertex) + } + } + } + return vertex + } + + private fun rotateRight(origin: AVLVertex): AVLVertex { + val left = + origin.left + ?: throw IllegalStateException("Height difference can't be 2 if left Vertex doesn't exist") + + left.parent = origin.parent + if (origin.parent?.left == origin) { + origin.parent?.left = left + } else { + origin.parent?.right = left + } + + origin.parent = left + origin.left = left.right + origin.left?.parent = origin + left.right = origin + + when (origin.diffHeight) { + 2 -> { + when (left.diffHeight) { + 0 -> { + origin.diffHeight = 1 + left.diffHeight = -1 + } + + 1 -> { + origin.diffHeight = 0 + left.diffHeight = 0 + } + + 2 -> { + origin.diffHeight = -1 + left.diffHeight = 0 + } + } + } + + 1 -> { + when (left.diffHeight) { + 0 -> { + origin.diffHeight = 0 + left.diffHeight = -1 + } + + 1 -> { + origin.diffHeight = -1 + left.diffHeight = -1 + } + + -1 -> { + origin.diffHeight = 0 + left.diffHeight = -2 + } + } + } + } + + if (origin == root) { + root = left + } + return left + } + + private fun rotateLeft(origin: AVLVertex): AVLVertex { + val right = + origin.right + ?: throw IllegalStateException("Height difference can't be 2 if left Vertex doesn't exist") + + right.parent = origin.parent + if (origin.parent?.left == origin) { + origin.parent?.left = right + } else { + origin.parent?.right = right + } + + origin.parent = right + origin.right = right.left + origin.right?.parent = origin + right.left = origin + + when (origin.diffHeight) { + -2 -> { + when (right.diffHeight) { + 0 -> { + origin.diffHeight = -1 + right.diffHeight = 1 + } + + -1 -> { + origin.diffHeight = 0 + right.diffHeight = 0 + } + + -2 -> { + origin.diffHeight = 1 + right.diffHeight = 0 + } + } + } + + -1 -> { + when (right.diffHeight) { + 0 -> { + origin.diffHeight = 0 + right.diffHeight = 1 + } + + -1 -> { + origin.diffHeight = 1 + right.diffHeight = 1 + } + + 1 -> { + origin.diffHeight = 0 + right.diffHeight = 2 + } + } + } + } + + if (origin == root) { + root = right + } + return right + } +} diff --git a/lib/src/main/kotlin/trees/implementations/RBTree.kt b/lib/src/main/kotlin/trees/implementations/RBTree.kt new file mode 100644 index 0000000..c99a739 --- /dev/null +++ b/lib/src/main/kotlin/trees/implementations/RBTree.kt @@ -0,0 +1,240 @@ +package trees.implementations + +import trees.abstracts.BalanceBSTree + +class RBTree, V> : BalanceBSTree>() { + + override fun createVertex(key: K, value: V): RBVertex { + return RBVertex(key, value) + } + + override fun set(key: K, value: V): V? { + val (currentVert, oldValue) = setWithoutBalance(key, value) + if (oldValue == null) { + size += 1 + } + if (currentVert == root) { + currentVert.color = black + } + balanceTreeAfterInsert(currentVert) + return oldValue + } + + private val red = RBVertex.Color.RED + private val black = RBVertex.Color.BLACK + + private fun rotateRight(vertex: RBVertex?) { + val parent = vertex?.parent + val leftChild = vertex?.left + vertex?.left = leftChild?.right + if (leftChild?.right != null) { + leftChild.right?.parent = vertex + } + leftChild?.right = vertex + vertex?.parent = leftChild + if (parent == null) { + root = leftChild + } else if (parent.left == vertex) { + parent.left = leftChild + } else if (parent.right == vertex) { + parent.right = leftChild + } + if (leftChild != null) { + leftChild.parent = parent + } + } + + private fun rotateLeft(vertex: RBVertex?) { + val parent = vertex?.parent + val rightChild = vertex?.right + vertex?.right = rightChild?.left + if (rightChild?.left != null) { + rightChild.left?.parent = vertex + } + rightChild?.left = vertex + vertex?.parent = rightChild + if (parent == null) { + root = rightChild + } else if (parent.left == vertex) { + parent.left = rightChild + } else if (parent.right == vertex) { + parent.right = rightChild + } + if (rightChild != null) { + rightChild.parent = parent + } + } + + private fun balanceTreeAfterInsert(vertex: RBVertex) { + var parent = vertex.parent + if (parent == null) { + vertex.color = black + return + } + if (parent.color == black) { + return + } + val grandparent = parent.parent + + if (grandparent == null) { + parent.color = black + return + } + + val uncle = getVertexUncle(parent) + if (uncle != null && uncle.color == red) { + parent.color = black + grandparent.color = red + uncle.color = black + balanceTreeAfterInsert(grandparent) + } else if (parent == grandparent.left) { + if (vertex == parent.right) { + rotateLeft(parent) + parent = vertex + } + rotateRight(grandparent) + parent.color = black + grandparent.color = red + } else { + if (vertex == parent.left) { + rotateRight(parent) + parent = vertex + } + rotateLeft(grandparent) + parent.color = black + grandparent.color = red + } + } + + override fun remove(key: K): V? { + val vertex = vertByKey(key) ?: return null + + size -= 1 + val replacedVertex: RBVertex? + val deletedVertexColor: RBVertex.Color + if (vertex.left == null || vertex.right == null) { + replacedVertex = deleteNullChild(vertex) + deletedVertexColor = vertex.color + } else { + val mVertex = minVertex(vertex.right!!)!! + vertex.value = mVertex.value + vertex.key = mVertex.key + replacedVertex = deleteNullChild(mVertex) + deletedVertexColor = mVertex.color + } + + if (deletedVertexColor == black) { + balanceTreeAfterDelete(replacedVertex) + if (replacedVertex?.additionalType == true) { + replaceChild(replacedVertex.parent, replacedVertex, null) + } + } + return replacedVertex?.value + } + + private fun balanceTreeAfterDelete(vertex: RBVertex?) { + if (vertex == root) { + vertex?.color = black + return + } + var brother = getBrother(vertex) + if (brother?.color == red) { + manageRedBrother(vertex, brother) + brother = getBrother(vertex) + } + if (brother?.left?.color == black && brother.right?.color == black) { + brother.color = red + if (vertex?.parent?.color == red) { + vertex.parent?.color = black + } else { + balanceTreeAfterDelete(vertex?.parent) + } + } else { + manageBlackRedOne(vertex, brother) + } + } + + private fun getBrother(vertex: RBVertex?): RBVertex? { + val parent = vertex?.parent + return when (vertex) { + parent?.left -> parent?.right + parent?.right -> parent?.left + else -> throw IllegalStateException() + } + } + + private fun manageBlackRedOne(vertex: RBVertex?, argBrother: RBVertex?) { + var brother = argBrother + val isParent = vertex == vertex?.parent?.left + if (isParent && brother?.right?.color == black) { + brother.left?.color = black + brother.color = red + rotateLeft(brother) + brother = vertex?.parent?.right + } else if (!isParent && brother?.left?.color == black) { + brother.right?.color = black + brother.color = red + rotateRight(brother) + brother = vertex?.parent?.left + } + brother?.color = vertex?.parent!!.color + vertex.parent?.color = black + } + + private fun manageRedBrother(vertex: RBVertex?, brother: RBVertex) { + brother.color = black + vertex?.parent?.color = red + if (vertex === vertex?.parent?.left) { + rotateLeft(vertex?.parent) + } else { + rotateRight(vertex?.parent) + } + } + + private fun replaceChild(parent: RBVertex?, oldChild: RBVertex, newChild: RBVertex?) { + if (parent == null) { + root = newChild + } else if (parent.left == oldChild) { + parent.left = newChild + } else if (parent.right == oldChild) { + parent.right = newChild + } else { + throw IllegalStateException() + } + if (newChild != null) { + newChild.parent = parent + } + } + + private fun deleteNullChild(vertex: RBVertex): RBVertex? { + println(vertex.key) + if (vertex.left != null) { + replaceChild(vertex.parent, vertex, vertex.left) + return vertex.left + } else if (vertex.right != null) { + replaceChild(vertex.parent, vertex, vertex.right) + return vertex.right + } else { + var newChild: RBVertex? = RBVertex(vertex.key, vertex.value) + if (vertex.color == black) { + newChild?.additionalType = true + newChild?.color = black + } else { + newChild = null + } + replaceChild(vertex.parent, vertex, newChild) + return newChild + } + } + + private fun getVertexUncle(parent: RBVertex): RBVertex? { + val grandparent = parent.parent + return if (grandparent?.left == parent) { + grandparent.right + } else if (grandparent?.right == parent) { + grandparent.left + } else { + throw IllegalStateException("Grandparent/Parent dependency mistake") + } + } +} diff --git a/lib/src/main/kotlin/trees/implementations/SimpleTree.kt b/lib/src/main/kotlin/trees/implementations/SimpleTree.kt new file mode 100644 index 0000000..ea397fe --- /dev/null +++ b/lib/src/main/kotlin/trees/implementations/SimpleTree.kt @@ -0,0 +1,48 @@ +package trees.implementations + +import trees.abstracts.BSTree + +class SimpleTree, V> : BSTree>() { + + override fun createVertex(key: K, value: V): SimpleVertex { + return SimpleVertex(key, value) + } + + override fun remove(key: K): V? { + val vertex = vertByKey(key) ?: return null + val parent = vertex.parent + val oldValue = vertex.value + if (vertex.left == null && vertex.right == null) { + when { + parent == null -> root = null + parent.left == vertex -> parent.left = null + else -> parent.right = null + } + } else { + val successor = if (vertex.right == null) { + maxVertex(vertex.left) + } else { + minVertex(vertex.right) + } + val successorParent = successor?.parent + successor?.let { + vertex.key = it.key + vertex.value = it.value + } + when { + successorParent?.left == successor -> successorParent?.left = null + successorParent?.right == successor -> successorParent?.right = null + } + } + --size + return oldValue + } + + override operator fun set(key: K, value: V): V? { + val oldValue = setWithoutBalance(key, value).second + if (oldValue == null) { + size += 1 + } + return oldValue + } +} diff --git a/lib/src/main/kotlin/trees/implementations/Vertices.kt b/lib/src/main/kotlin/trees/implementations/Vertices.kt new file mode 100644 index 0000000..e2bb48f --- /dev/null +++ b/lib/src/main/kotlin/trees/implementations/Vertices.kt @@ -0,0 +1,25 @@ +package trees.implementations + +import trees.abstracts.Vertex + +class SimpleVertex, V>(key: K, value: V) : Vertex>(key, value) + +class AVLVertex, V>(key: K, value: V) : Vertex>(key, value) { + var diffHeight: Int = 0 + internal set(value) { + if (value !in -2..2) { + throw IllegalArgumentException("difference of heights can't be out of [-2,2]") + } + field = value + } +} + +class RBVertex, V>(key: K, value: V) : Vertex>(key, value) { + var color: Color = Color.RED + var additionalType = false + + enum class Color { + BLACK, + RED, + } +} diff --git a/lib/src/test/kotlin/trees/avltest/AvlGeneralTest.kt b/lib/src/test/kotlin/trees/avltest/AvlGeneralTest.kt new file mode 100644 index 0000000..4501ea3 --- /dev/null +++ b/lib/src/test/kotlin/trees/avltest/AvlGeneralTest.kt @@ -0,0 +1,408 @@ +package trees.avltest + +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.assertThrows +import trees.avltest.AvlSpecificTest.Companion.checkTreeInvariant +import trees.implementations.AvlTree +import kotlin.test.assertContentEquals +import kotlin.test.assertEquals +import kotlin.test.assertIs + +class AvlGeneralTest { + private lateinit var avlTree: AvlTree + + @BeforeEach + fun setup() { + avlTree = AvlTree() + } + + @Test + fun `simple array test`() { + val array = intArrayOf(0, 1, 2, 3, 4) + for (i in array) { + avlTree[i] = -i + } + val expectedGet: Array = Array(5) { i -> -i } + val actualGet: Array = Array(5) { i -> avlTree[i] } + assertContentEquals(expectedGet, actualGet, "Get method must return the value associated with the key") + val expectedSize = 5 + val actualSize = avlTree.size + assertEquals(expectedSize, actualSize, "Size the tree must correspond to the number key-value pairs") + checkTreeInvariant(avlTree.root) + } + + @Test + fun `size of avl tree with duplicate keys`() { + for (i in 1..10) { + avlTree[i] = i + 30 + } + for (i in 6..10) { + avlTree[i] = 0 + } + + val expectedSize = 10 + val actualSize = avlTree.size + assertEquals( + expectedSize, + actualSize, + "Size of the tree must not change after overwriting an existing key", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `set keys twice`() { + for (i in 1..10) { + avlTree[i] = 30 + i + } + for (i in 1..10) { + avlTree[i] = 0 + } + + val expectedSize = 10 + val actualSize = avlTree.size + assertEquals( + expectedSize, + actualSize, + "Size of the tree must not change after overwriting an existing key", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `set return`() { + assertEquals( + avlTree.set(44, -37), + null, + "Set must return null if set key was not present in the tree", + ) + + assertEquals( + avlTree.set(44, 152), + -37, + "Set must return previous value associated with the key", + ) + } + + @Test + fun `simple remove`() { + avlTree[0] = 5 + + val expectedResult = 5 + val actualResult = avlTree.remove(0) + val expectedSize = 0 + val actualSize = avlTree.size + + assertEquals( + expectedResult, + actualResult, + "Remove must return removed value", + ) + assertEquals( + expectedSize, + actualSize, + "Size of the tree must decrease after removing the existing key", + ) + } + + @Test + fun `remove a non-existent key`() { + avlTree[0] = 15 + avlTree.remove(0) + + val expectedResult = null + val actualResult = avlTree.remove(0) + assertEquals( + expectedResult, + actualResult, + "Remove a non-existent key must return null", + ) + } + + @Test + fun `remove root of left subtree with existing left vertex`() { + val keys = intArrayOf(0, -1, 1, -2) + for (key in keys) avlTree[key] = key + avlTree.remove(-1) + + val expectedResult = arrayOf(0, null, 1, -2) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Tree must save all other vertices after remove vertex with existing left vertex", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `remove root of right subtree with existing left vertex`() { + val keys = intArrayOf(0, -1, 2, 1) + for (key in keys) avlTree[key] = key + avlTree.remove(2) + + val expectedResult = arrayOf(0, -1, null, 1) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Tree must save all other vertices after remove root of right subtree with existing left vertex", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `remove with right subtree of height 1`() { + val keys = intArrayOf(0, -1, 3, 1, 2) + for (key in keys) avlTree[key] = key + avlTree.remove(3) + + val expectedResult = arrayOf(0, -1, null, 1, 2) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Tree must save all other vertices after remove vertex with right subtree of height 1", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `remove with right subtree of height more than 1`() { + val keys = intArrayOf(0, -1, 3, -2, 1, 6, 4, 7) + for (key in keys) avlTree[key] = key + avlTree.remove(3) + + val expectedResult = arrayOf(0, -1, null, -2, 1, 6, 4, 7) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Tree must save all other vertices after remove vertex with right subtree of height >1", + ) + checkTreeInvariant(avlTree.root) + avlTree[5] = 5 + checkTreeInvariant(avlTree.root) + } + + @Test + fun `simple iteration`() { + val keys = intArrayOf(1, 7, 4, 9, 2, -44, 3) + val values = intArrayOf(19, 14, 31, 17, 12, -34, 0) + for (i in keys.indices) { + avlTree[keys[i]] = values[i] + } + + val expectedResult: Array = arrayOf(-34, 19, 12, 0, 31, 14, 17) + val iterator = avlTree.iterator() + val actualResult: Array = Array(7) { iterator.next().second } + assertContentEquals(expectedResult, actualResult, "Iterator must return vertices in keys order") + checkTreeInvariant(avlTree.root) + } + + @Test + fun `iteration outOfBonds exception`() { + val keys = intArrayOf(1, 3, 5, 7, 9, 12, 342, -488) + for (key in keys) avlTree[key] = key + val iterator = avlTree.iterator() + for (key in keys) { + assertIs>( + iterator.next(), + "iterator.next() must return Pair while all keys is not bypassed", + ) + } + assertThrows( + "Iterator must throw IndexOutOfBondsException after next() if all keys is bypassed", + ) { + iterator.next() + } + } + + @Test + fun clear() { + val keys = intArrayOf(1, 2, 7, 2, 4, 9) + for (key in keys) avlTree[key] = -key + avlTree.clear() + + assertEquals(avlTree.size, 0, "Size of the tree must be 0 after clear") + assertEquals(avlTree.root, null, "Root of the tree must be null after clear") + } + + @Test + fun `contains key`() { + val keys = intArrayOf(1, 7, 3, -34, 45) + for (key in keys) avlTree[key] = key + + for (key in keys) { + assertEquals( + avlTree.containsKey(key), + true, + "containsKey must return true for keys existing in the tree", + ) + } + avlTree.remove(-34) + val keysNotInTheTree = intArrayOf(102, 57, -22, -34) + for (key in keysNotInTheTree) { + assertEquals( + avlTree.containsKey(key), + false, + "containsKey must return false for keys not existing in the tree", + ) + } + } + + @Test + fun isNotEmpty() { + assertEquals(avlTree.isNotEmpty(), false, "isNotEmpty must return false if tree is empty") + + val keys = intArrayOf(1, 45, -10045, 0, -10000, 3000004) + for (key in keys) avlTree[key] = key + + assertEquals(avlTree.isNotEmpty(), true, "isNotEmpty must return true if tree is not empty") + + avlTree.clear() + + assertEquals(avlTree.isNotEmpty(), false, "isNotEmpty must return false if tree is empty") + } + + @Test + fun isEmpty() { + assertEquals(avlTree.isEmpty(), true, "isEmpty must return true if tree is empty") + + avlTree[14] = 902 + + assertEquals(avlTree.isEmpty(), false, "isEmpty must return false if tree is not empty") + + avlTree.remove(14) + + assertEquals(avlTree.isEmpty(), true, "isEmpty must return true if tree is empty") + } + + @Test + fun max() { + val keys = intArrayOf(0, -1, 1, -45, 5, 4, 2, 3) + for (key in keys) avlTree[key] = key + + val expectedResult = Pair(5, 5) + val actualResult = avlTree.max() + + assertEquals(expectedResult, actualResult, "Max must return Pairs by max key in the tree") + checkTreeInvariant(avlTree.root) + } + + @Test + fun `max after remove max key with double rotate`() { + val keys = intArrayOf(5, 1, 6, 0, 3, 7, 2, 4) + for (key in keys) avlTree[key] = key + avlTree.remove(7) + + val expectedResult = Pair(6, 6) + val actualResult = avlTree.max() + + assertEquals(expectedResult, actualResult, "Max must return Pair by max key in the tree") + checkTreeInvariant(avlTree.root) + } + + @Test + fun min() { + val keys = intArrayOf(54, 88, 4332, -46, -2) + for (key in keys) avlTree[key] = key + + val expectedResult = Pair(-46, -46) + val actualResult = avlTree.min() + assertEquals(expectedResult, actualResult, "Min must return Pair by min key in the tree") + checkTreeInvariant(avlTree.root) + } + + @Test + fun `min after remove min key with double rotate`() { + val keys = intArrayOf(2, 1, 6, 0, 4, 7, 3, 5) + for (key in keys) avlTree[key] = key + avlTree.remove(0) + + val expectedResult = Pair(1, 1) + val actualResult = avlTree.min() + + assertEquals(expectedResult, actualResult, "Min must return Pair by min key in the tree") + checkTreeInvariant(avlTree.root) + } + + @Test + fun `getOrSet with existing key`() { + avlTree[25] = -48 + + val expectedResult = -48 + val actualResult = avlTree.getOrSet(25, 90) + assertEquals( + expectedResult, + actualResult, + "getOrSet must return value corresponding to the specified key if it's presented in the tree", + ) + } + + @Test + fun `getOrSet with non existing key`() { + assertEquals( + avlTree.getOrSet(0, -10500), + null, + "getOrSet must return null if key is not presented in the tree", + ) + assertEquals( + avlTree[0], + -10500, + "getOrSet must set specified key-value if key was not presented in the tree", + ) + } + + @Test + fun `getOrDefault with existing key`() { + avlTree[45] = 45 + + val expectedResult = 45 + val actualResult = avlTree.getOrDefault(45, "Default") + assertEquals( + expectedResult, + actualResult, + "getOrDefault must return value corresponding to the specified key if it's presented in the tree", + ) + } + + @Test + fun `getOrDefault with non existing key`() { + val expectedResult = "Default" + val actualResult = avlTree.getOrDefault(100, "Default") + assertEquals( + expectedResult, + actualResult, + "getOrDefault must return defaultValue if key is not presented in the tree", + ) + } + + @Test + fun `setIfAbsent when not absent`() { + avlTree[520] = 520 + avlTree.setIfAbsent(520, -200) + + val expectedResult = 520 + val actualResult = avlTree[520] + assertEquals( + expectedResult, + actualResult, + "setIfAbsent must not change value if key is presented in the tree", + ) + } + + @Test + fun `setIfAbsent when absent`() { + avlTree.setIfAbsent(-100, 250) + + val expectedResult = 250 + val actualResult = avlTree[-100] + assertEquals( + expectedResult, + actualResult, + "setIfAbsent must set specified value under specified key if key was not presented in the tree", + ) + } +} diff --git a/lib/src/test/kotlin/trees/avltest/AvlSpecificTest.kt b/lib/src/test/kotlin/trees/avltest/AvlSpecificTest.kt new file mode 100644 index 0000000..04d592d --- /dev/null +++ b/lib/src/test/kotlin/trees/avltest/AvlSpecificTest.kt @@ -0,0 +1,269 @@ +package trees.avltest + +import org.junit.jupiter.api.Assertions.assertTrue +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import trees.implementations.AVLVertex +import trees.implementations.AvlTree +import kotlin.test.assertContentEquals +import kotlin.test.assertEquals + +class AvlSpecificTest { + private lateinit var avlTree: AvlTree + + companion object { + /** + * Traverse all vertices of the tree and asserts that their diffHeights are + * equal to real height difference of the subtrees. + * @return height of the subtree with the root at the specified [vertex] + */ + fun checkTreeInvariant(vertex: AVLVertex<*, *>?): Int { + if (vertex == null) return 0 + + val leftSubtreeHeight = checkTreeInvariant(vertex.left) + val rightSubtreeHeight = checkTreeInvariant(vertex.right) + val difference = leftSubtreeHeight - rightSubtreeHeight + assertTrue( + difference in -1..1, + "Height difference of subtrees must be in [-1,1]", + ) + assertEquals( + difference, + vertex.diffHeight, + "Property diffHeights must match real Height difference of subtrees (key = ${vertex.key})", + ) + return maxOf(checkTreeInvariant(vertex.left), checkTreeInvariant(vertex.right)) + 1 + } + } + + @BeforeEach + fun setup() { + avlTree = AvlTree() + } + + @Test + fun `remove with double rotate`() { + val keys = intArrayOf(5, 0, 7, -1, 2, 6, 9, -2, 1, 3, 8, 4) + for (key in keys) avlTree[key] = key + avlTree.remove(7) + + val expectedResult = arrayOf(5, 0, null, -1, 2, 6, 9, -2, 1, 3, 8, 4) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Tree must save all other vertices after remove that creates unbalance situation", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `remove root with double rotate`() { + val keys = intArrayOf(4, 1, 6, 0, 3, 5, 2) + for (key in keys) avlTree[key] = key + avlTree.remove(4) + + assertTrue(avlTree.root != null) + val expectedResult = arrayOf(null, 1, 6, 0, 3, 5, 2) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Tree must save all other vertices after root remove", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `rotate left, right diffHeight = -1`() { + val keys = intArrayOf(0, -1, 2, 1, 3, 4) + for (key in keys) avlTree[key] = key + + val expectedResult = Array(keys.size) { i -> keys[i] } + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after left rotate ( right.diffHeight = -1)", + ) + checkTreeInvariant(avlTree.root) + +// 0 0 2 +// / \ / \ / \ +// -1 2 -1 2 0 3 +// / \ --> / \ --> / \ \ +// 1 3 1 3 -1 1 4 +// \ +// 4 + } + + @Test + fun `rotate left, right diffHeight = 0`() { + val keys = intArrayOf(0, -1, 4, 2, 6, -2, 1, 3, 5, 7) + for (key in keys) avlTree[key] = key + avlTree.remove(-2) + + val expectedResult = arrayOf(0, -1, 4, 2, 6, null, 1, 3, 5, 7) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after left rotate (right.diffHeight = 0)", + ) + checkTreeInvariant(avlTree.root) +// 0 0 4 +// / \ / \ / \ +// -1 4 -1 4 0 6 +// / / \ --> / \ --> / \ / \ +// -2 2 6 2 6 -1 2 5 7 +// / \ / \ / \ / \ / \ +// 1 3 5 7 1 3 5 7 1 3 + } + + @Test + fun `rotate right, left diffHeight = 1`() { + val keys = intArrayOf(0, 1, -1, -3, -2, -4) + for (key in keys) avlTree[key] = key + + val expectedResult = Array(keys.size) { i -> keys[i] } + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after right rotate (left.diffHeight = 1)", + ) + checkTreeInvariant(avlTree.root) + +// 0 0 -1 +// / \ / \ / \ +// -1 1 -1 1 -3 0 +// / \ --> / \ --> / / \ +// -3 -2 -3 -2 -4 -2 1 +// / +// -4 + } + + @Test + fun `rotate right, left diffHeight = 0`() { + val keys = intArrayOf(7, 3, 8, 9, 1, 5, 0, 2, 4, 6) + for (key in keys) avlTree[key] = key + avlTree.remove(9) + + val expectedResult = arrayOf(7, 3, 8, null, 1, 5, 0, 2, 4, 6) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after right rotate (left.diffHeight = 0)", + ) + checkTreeInvariant(avlTree.root) + +// 7 7 3 +// / \ / \ / \ +// 3 8 3 8 1 7 +// / \ \ --> / \ --> / \ / \ +// 1 5 9 1 5 0 2 5 8 +// / \ / \ / \ / \ / \ +// 0 2 4 6 0 2 4 6 4 6 + } + + @Test + fun `rotate right-left, right diffHeight is 1, right-left diffHeight is 1`() { + val keys = intArrayOf(1, 0, 4, 3, 5, 2) + for (key in keys) avlTree[key] = key + + val expectedResult = Array(keys.size) { i -> keys[i] } + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after right-left rotate with right.left.diffHeight = 1", + ) + checkTreeInvariant(avlTree.root) + +// 1 1 3 +// / \ / \ / \ +// 0 4 0 3 1 4 +// / \ --> / \ --> / \ \ +// 3 5 2 4 0 2 5 +// / \ +// 2 5 + } + + @Test + fun `rotate right-left, right diffHeight is 1, right-left diffHeight is 0`() { + val keys = intArrayOf(2, 1, 6, 0, 4, 7, 3, 5) + for (key in keys) avlTree[key] = key + avlTree.remove(0) + + val expectedResult: Array = arrayOf(2, 1, 6, null, 4, 7, 3, 5) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after right-left rotate with right.left.diffHeight = 0", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `rotate right-left, right diffHeight is 1, right-left diffHeight is -1`() { + val keys = intArrayOf(1, 0, 4, 2, 5, 3) + for (key in keys) avlTree[key] = key + + val expectedResult = Array(keys.size) { i -> keys[i] } + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after right-left rotate with right.left.diffHeight = -1", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `rotate left-right, left diffHeight is -1, left-right diffHeight is -1`() { + val keys = intArrayOf(4, 1, 5, 0, 2, 3) + for (key in keys) avlTree[key] = key + + val expectedResult = Array(keys.size) { i -> keys[i] } + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after left-right rotate with left.right.diffHeight = -1", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `rotate left-right, left diffHeight is -1, left-right diffHeight is 0`() { + val keys = intArrayOf(5, 1, 6, 0, 3, 7, 2, 4) + for (key in keys) avlTree[key] = key + avlTree.remove(7) + + val expectedResult = arrayOf(5, 1, 6, 0, 3, null, 2, 4) + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after left-right rotate with left.right.diffHeight = 0", + ) + checkTreeInvariant(avlTree.root) + } + + @Test + fun `rotate left-right, left diffHeight is -1, left-right diffHeight is 1`() { + val keys = intArrayOf(4, 1, 5, 0, 3, 2) + for (key in keys) avlTree[key] = key + + val expectedResult = Array(keys.size) { i -> keys[i] } + val actualResult = Array(keys.size) { i -> avlTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + "Get must return corresponding values after left-right rotate with left.right.diffHeight = 1", + ) + checkTreeInvariant(avlTree.root) + } +} diff --git a/lib/src/test/kotlin/trees/bstest/BSTreeTest.kt b/lib/src/test/kotlin/trees/bstest/BSTreeTest.kt new file mode 100644 index 0000000..f8466fa --- /dev/null +++ b/lib/src/test/kotlin/trees/bstest/BSTreeTest.kt @@ -0,0 +1,141 @@ +package trees.bstest + +import org.junit.jupiter.api.Assertions.assertNull +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import trees.implementations.SimpleTree +import kotlin.test.assertContentEquals +import kotlin.test.assertEquals + +class BSTreeTest { + private lateinit var simpleTree: SimpleTree + + @BeforeEach + fun setup() { + simpleTree = SimpleTree() + } + + @Test + fun `check empty tree`() { + assertNull(simpleTree.root) + assertEquals(0, simpleTree.size) + } + + @Test + fun `insert and find`() { + val array = intArrayOf(0, 1, 2, 3, 4, 5, 6, 7) + for (i in array) { + simpleTree[i] = -i + } + val expectedGet: Array = Array(7) { i -> -i } + val actualGet: Array = Array(7) { i -> simpleTree[i] } + assertContentEquals(expectedGet, actualGet, "Get method must return the value associated with the key") + val expectedSize = array.size + val actualSize = simpleTree.size + assertEquals(expectedSize, actualSize) + } + + @Test + fun `simple delete`() { + val array = intArrayOf(0, 1, 2, 3, 4, 5, 6) + for (i in array) { + simpleTree[i] = i + } + + val expectedResult = 3 + val actualResult = simpleTree.remove(3) + assertEquals(expectedResult, actualResult) + + val expectedSize = array.size - 1 + val actualSize = simpleTree.size + assertEquals(expectedSize, actualSize) + } + + @Test + fun `size with duplicate keys`() { + for (i in 1..10) { + simpleTree[i] = i + 30 + } + for (i in 6..10) { + simpleTree[i] = 0 + } + + val expectedSize = 10 + val actualSize = simpleTree.size + assertEquals(expectedSize, actualSize) + } + + @Test + fun `twice keys`() { + for (i in 1..10) { + simpleTree[i] = 30 + i + } + for (i in 1..10) { + simpleTree[i] = 0 + } + + val expectedSize = 10 + val actualSize = simpleTree.size + assertEquals(expectedSize, actualSize) + } + + @Test + fun `remove non existent key`() { + simpleTree[0] = 15 + val actualResult = simpleTree.remove(3) + val expectedResult = null + assertEquals(expectedResult, actualResult) + } + + @Test + fun `remove root of left subtree`() { + val keys = intArrayOf(0, -1, 1, -2) + for (i in keys) { + simpleTree[i] = i + } + simpleTree.remove(-1) + + val expectedResult: Array = arrayOf(0, null, 1, -2) + val actualResult = Array(keys.size) { j -> simpleTree[keys[j]] } + assertContentEquals(expectedResult, actualResult) + } + + @Test + fun `remove root of right subtree`() { + val keys = intArrayOf(0, -1, 2, 1) + for (i in keys) { + simpleTree[i] = i + } + simpleTree.remove(-1) + + val expectedResult: Array = arrayOf(0, null, 2, 1) + val actualResult = Array(keys.size) { j -> simpleTree[keys[j]] } + assertContentEquals(expectedResult, actualResult) + } + + @Test + fun `remove root with 2 children`() { + val keys = intArrayOf(0, -1, 2, 1, 3) + for (key in keys) { + simpleTree[key] = key + } + simpleTree.remove(2) + + val expectedResult: Array = arrayOf(0, -1, null, 1, 3) + val actualResult = Array(keys.size) { i -> simpleTree[keys[i]] } + assertContentEquals(expectedResult, actualResult) + } + + @Test + fun `remove right root without children`() { + val keys = intArrayOf(0, -1, 2) + for (key in keys) { + simpleTree[key] = key + } + simpleTree.remove(2) + + val expectedResult: Array = arrayOf(0, -1, null) + val actualResult = Array(keys.size) { i -> simpleTree[keys[i]] } + assertContentEquals(expectedResult, actualResult) + } +} diff --git a/lib/src/test/kotlin/trees/rbtest/RBTest.kt b/lib/src/test/kotlin/trees/rbtest/RBTest.kt new file mode 100644 index 0000000..ec695bf --- /dev/null +++ b/lib/src/test/kotlin/trees/rbtest/RBTest.kt @@ -0,0 +1,202 @@ +package trees.rbtest + +import org.junit.jupiter.api.Assertions +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import trees.implementations.RBTree +import kotlin.test.assertContentEquals +import kotlin.test.assertEquals + +class RBTest { + private lateinit var rbTree: RBTree + + @BeforeEach + fun setup() { + rbTree = RBTree() + } + + @Test + fun `simple array test`() { + val array = intArrayOf(0, 1, 2, 3, 4) + for (i in array) { + rbTree[i] = i + } + val expectedGet: Array = Array(5) { i -> i } + val actualGet: Array = Array(5) { i -> rbTree[i] } + assertContentEquals(expectedGet, actualGet, "Get method must return the value associated with the key") + val expectedSize = 5 + val actualSize = rbTree.size + assertEquals(expectedSize, actualSize, "Size the tree must correspond to the number key-value pairs") + } + + @Test + fun `array test`() { + val array = intArrayOf(2, 1, 3, 0, 4) + for (i in array) { + rbTree[i] = i + } + val expectedGet: Array = Array(5) { i -> i } + val actualGet: Array = Array(5) { i -> rbTree[i] } + assertContentEquals(expectedGet, actualGet, "Get method must return the value associated with the key") + val expectedSize = 5 + val actualSize = rbTree.size + assertEquals(expectedSize, actualSize, "Size the tree must correspond to the number key-value pairs") + } + + @Test + fun `size of red black tree with duplicate keys`() { + for (i in 1..10) { + rbTree[i] = i + 30 + } + for (i in 6..10) { + rbTree[i] = 0 + } + + val expectedSize = 10 + val actualSize = rbTree.size + assertEquals( + expectedSize, + actualSize, + "Size of the tree must not change after overwriting an existing key", + ) + } + + @Test + fun `simple array set test`() { + for (i in 0..19) { + rbTree[i] = i + } + + for (i in 0..19) { + val expectedContains = rbTree[i] + assertEquals(expectedContains, i, "Added and not removed element does not contain in the tree") + } + + val expectedGet: Array = Array(20) { i -> i } + val actualGet: Array = Array(20) { i -> rbTree[i] } + assertContentEquals(expectedGet, actualGet, "Get method must return the value associated with the key") + val expectedSize = 20 + val actualSize = rbTree.size + assertEquals(expectedSize, actualSize, "Size the tree must correspond to the number key-value pairs") + } + + @Test + fun `simple array set remove test`() { + for (i in 0..19) { + rbTree[i] = i + } + for (i in 10..19) { + rbTree.remove(i) + } + for (i in 10..19) { + val expectedNotContains = rbTree[i] + assertEquals(expectedNotContains, null, "Removed element contains in the tree") + } + for (i in 0..9) { + val expectedContains = rbTree[i] + assertEquals(expectedContains, i, "Added and not removed element does not contain in the tree") + } + + val expectedGet: Array = Array(10) { i -> i } + val actualGet: Array = Array(10) { i -> rbTree[i] } + assertContentEquals(expectedGet, actualGet, "Get method must return the value associated with the key") + val expectedSize = 10 + val actualSize = rbTree.size + assertEquals(expectedSize, actualSize, "Size the tree must correspond to the number key-value pairs") + } + + @Test + fun `not simple array set remove test`() { + for (i in 19 downTo 0) { + rbTree[19 - i] = i + } + for (i in 8..19) { + rbTree.remove(i) + } + + for (i in 8..19) { + val expectedNotContains = rbTree[i] + assertEquals(expectedNotContains, null, "Removed element contains in the tree") + } + for (i in 0..7) { + val expectedContains = rbTree[i] + assertEquals(expectedContains, 19 - i, "Added and not removed element does not contain in the tree") + } + } + + @Test + fun `adding and removing all elements test`() { + for (i in 0..19) { + rbTree[i] = i + } + for (i in 0..19) { + rbTree.remove(i) + } + for (i in 0..19) { + val expectedNotContains = rbTree[i] + assertEquals(expectedNotContains, null, "Removed element contains in the tree") + } + + val expectedGet: Array = emptyArray() + val actualGet: Array = Array(rbTree.size) { i -> rbTree[i] } + assertContentEquals(expectedGet, actualGet, "Get method must return the value associated with the key") + val expectedSize = 0 + val actualSize = rbTree.size + assertEquals(expectedSize, actualSize, "Size the tree must correspond to the number key-value pairs") + } + + @Test + fun `rotate left`() { + val keys = intArrayOf(0, -1, 4, 2, 6, -2, 1, 3, 5, 7) + for (key in keys) rbTree[key] = key + rbTree.remove(-2) + + val expectedResult = arrayOf(0, -1, 4, 2, 6, null, 1, 3, 5, 7) + val actualResult = Array(keys.size) { i -> rbTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + ) + } + + @Test + fun `rotate right`() { + val keys = intArrayOf(0, 1, -1, -3, -2, -4) + for (key in keys) rbTree[key] = key + + val expectedResult = Array(keys.size) { i -> keys[i] } + val actualResult = Array(keys.size) { i -> rbTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + ) + } + + @Test + fun `remove root with rotate`() { + val keys = intArrayOf(4, 1, 6, 0, 3, 5, 2) + for (key in keys) rbTree[key] = key + rbTree.remove(4) + Assertions.assertTrue(rbTree.root != null) + val expectedResult = arrayOf(null, 1, 6, 0, 3, 5, 2) + val actualResult = Array(keys.size) { i -> rbTree[keys[i]] } + assertContentEquals( + expectedResult, + actualResult, + ) + } + + @Test + fun `remove a non-existent key`() { + rbTree[0] = 15 + rbTree.remove(0) + + val expectedResult = null + val actualResult = rbTree.remove(0) + assertEquals( + expectedResult, + actualResult, + "Remove a non-existent key must return null", + ) + } +} diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..7ba494f --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,14 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * For more detailed information on multi-project builds, please refer to https://docs.gradle.org/8.6/userguide/multi_project_builds.html in the Gradle documentation. + */ + +plugins { + // Apply the foojay-resolver plugin to allow automatic download of JDKs + id("org.gradle.toolchains.foojay-resolver-convention") version "0.7.0" +} + +rootProject.name = "trees-8" +include("lib")