commit 9fcf8e29214210612d545bed50d7f889800ac639 Author: Alexander Kiryukhin Date: Sun May 1 21:50:12 2022 +0300 Initial diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/channels/doc.go b/channels/doc.go new file mode 100644 index 0000000..0ac1c76 --- /dev/null +++ b/channels/doc.go @@ -0,0 +1,2 @@ +// Функции работы над каналами +package channels diff --git a/channels/fanin.go b/channels/fanin.go new file mode 100644 index 0000000..679aeee --- /dev/null +++ b/channels/fanin.go @@ -0,0 +1,23 @@ +package channels + +import "sync/atomic" + +// FanIn сливает несколько каналов в один +func FanIn[T any](chans ...chan T) chan T { + out := make(chan T) + workers := int64(len(chans)) + for _, ch := range chans { + func(ch chan T) { + go func() { + for t := range ch { + out <- t + } + atomic.AddInt64(&workers, -1) + if workers == 0 { + close(out) + } + }() + }(ch) + } + return out +} diff --git a/channels/fanin_test.go b/channels/fanin_test.go new file mode 100644 index 0000000..dd0c889 --- /dev/null +++ b/channels/fanin_test.go @@ -0,0 +1,57 @@ +package channels + +import ( + "reflect" + "sort" + "testing" +) + +func TestFanIn(t *testing.T) { + type args struct { + chans [][]int + } + tests := []struct { + name string + args args + want []int + }{ + { + name: "test fanin", + args: args{ + chans: [][]int{ + {1, 2, 3}, + {4, 5, 6}, + {7, 8, 9}, + }, + }, + want: []int{1, 2, 3, 4, 5, 6, 7, 8, 9}, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := []int{} + chans := make([]chan int, len(tt.args.chans)) + for i, v := range tt.args.chans { + func(i int, v []int) { + chans[i] = make(chan int, len(v)) + go func(i int, v []int) { + for _, v2 := range v { + chans[i] <- v2 + } + close(chans[i]) + }(i, v) + }(i, v) + } + + ch := FanIn(chans...) + + for o := range ch { + got = append(got, o) + } + sort.Ints(got) + if !reflect.DeepEqual(got, tt.want) { + t.Errorf("FanIn() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/channels/fanout.go b/channels/fanout.go new file mode 100644 index 0000000..23a32b4 --- /dev/null +++ b/channels/fanout.go @@ -0,0 +1,23 @@ +package channels + +// FanOut раскидывает очередь канала на несколько каналов равномерно +func FanOut[T any](in chan T, workers int) []chan T { + out := make([]chan T, workers) + for i := 0; i < workers; i++ { + out[i] = make(chan T) + } + go func() { + i := 0 + for t := range in { + out[i] <- t + i++ + if i == workers { + i = 0 + } + } + for i := 0; i < workers; i++ { + close(out[i]) + } + }() + return out +} diff --git a/channels/fanout_test.go b/channels/fanout_test.go new file mode 100644 index 0000000..f8b0380 --- /dev/null +++ b/channels/fanout_test.go @@ -0,0 +1,48 @@ +package channels + +import ( + "reflect" + "sort" + "testing" +) + +func TestFanOut(t *testing.T) { + type args struct { + in []int + workers int + } + tests := []struct { + name string + args args + }{ + { + name: "test fanout - fanin", + args: args{ + in: []int{1, 2, 3, 4, 5, 6, 7, 8, 9}, + workers: 2, + }, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + in := make(chan int) + go func() { + for _, v := range tt.args.in { + in <- v + } + close(in) + }() + + ch := FanOut(in, tt.args.workers) + gotCh := FanIn(ch...) + got := []int{} + for v := range gotCh { + got = append(got, v) + } + sort.Ints(got) + if !reflect.DeepEqual(got, tt.args.in) { + t.Errorf("FanIn() = %v, want %v", got, tt.args.in) + } + }) + } +} diff --git a/collections/doc.go b/collections/doc.go new file mode 100644 index 0000000..ebb2322 --- /dev/null +++ b/collections/doc.go @@ -0,0 +1,2 @@ +// Функции работы над обобщенными коллекциями +package collections diff --git a/collections/merge.go b/collections/merge.go new file mode 100644 index 0000000..6fcf875 --- /dev/null +++ b/collections/merge.go @@ -0,0 +1,41 @@ +package collections + +import "go.neonxp.dev/extra/utils" + +// MergeScalar стабильное слияние двух слайсов скаляров +func MergeScalar[T utils.Scalar](s1, s2 []T) []T { + i, j := 0, 0 + len1, len2 := len(s1), len(s2) + result := make([]T, 0, len1+len2) + for i < len1 && j < len2 { + if s1[i] < s2[j] { + result = append(result, s1[i]) + i++ + continue + } + result = append(result, s2[j]) + j++ + } + result = append(result, s1[i:]...) + result = append(result, s2[j:]...) + return result +} + +// Merge стабильное слияние двух слайсов +func Merge[T utils.Sortable[T]](s1, s2 []T) []T { + i, j := 0, 0 + len1, len2 := len(s1), len(s2) + result := make([]T, 0, len1+len2) + for i < len1 && j < len2 { + if s1[i].Less(s2[j]) { + result = append(result, s1[i]) + i++ + continue + } + result = append(result, s2[j]) + j++ + } + result = append(result, s1[i:]...) + result = append(result, s2[j:]...) + return result +} diff --git a/collections/merge_test.go b/collections/merge_test.go new file mode 100644 index 0000000..27f5ba0 --- /dev/null +++ b/collections/merge_test.go @@ -0,0 +1,92 @@ +package collections + +import ( + "reflect" + "testing" +) + +func TestMergeScalar(t *testing.T) { + type args struct { + s1 []int + s2 []int + } + tests := []struct { + name string + args args + want []int + }{ + { + name: "test 1", + args: args{ + s1: []int{1, 2, 4, 5, 6}, + s2: []int{3, 3}, + }, + want: []int{1, 2, 3, 3, 4, 5, 6}, + }, + { + name: "test 2", + args: args{ + s1: []int{1, 3, 5, 7}, + s2: []int{0, 2, 4, 6, 8}, + }, + want: []int{0, 1, 2, 3, 4, 5, 6, 7, 8}, + }, + { + name: "test 3", + args: args{ + s1: []int{8, 6, 4, 2, 0}, + s2: []int{1, 3, 5, 7}, + }, + want: []int{1, 3, 5, 7, 8, 6, 4, 2, 0}, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := MergeScalar(tt.args.s1, tt.args.s2); !reflect.DeepEqual(got, tt.want) { + t.Errorf("MergeScalar() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestMerge(t *testing.T) { + type args struct { + s1 []*myType + s2 []*myType + } + tests := []struct { + name string + args args + want []*myType + }{ + { + name: "test1", + args: args{ + s1: []*myType{ + {400}, {200}, {100}, + }, + s2: []*myType{ + {300}, + }, + }, + want: []*myType{ + {400}, {300}, {200}, {100}, + }, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := Merge(tt.args.s1, tt.args.s2); !reflect.DeepEqual(got, tt.want) { + t.Errorf("Merge() = %v, want %v", got, tt.want) + } + }) + } +} + +type myType struct { + Weight int +} + +func (t *myType) Less(t2 *myType) bool { + return t2.Weight < t.Weight +} diff --git a/doc.md b/doc.md new file mode 100755 index 0000000..fae5397 --- /dev/null +++ b/doc.md @@ -0,0 +1,278 @@ + + +# channels + +```go +import "go.neonxp.dev/extra/channels" +``` + +Функции работы над каналами + +## Index + +- [func FanIn[T any](chans ...chan T) chan T](<#func-fanin>) +- [func FanOut[T any](in chan T, workers int) []chan T](<#func-fanout>) + + +## func FanIn + +```go +func FanIn[T any](chans ...chan T) chan T +``` + +FanIn сливает несколько каналов в один + +## func FanOut + +```go +func FanOut[T any](in chan T, workers int) []chan T +``` + +FanOut раскидывает очередь канала на несколько каналов равномерно + +# collections + +```go +import "go.neonxp.dev/extra/collections" +``` + +Функции работы над обобщенными коллекциями + +## Index + +- [func Merge[T utils.Sortable[T]](s1, s2 []T) []T](<#func-merge>) +- [func MergeScalar[T utils.Scalar](s1, s2 []T) []T](<#func-mergescalar>) + + +## func Merge + +```go +func Merge[T utils.Sortable[T]](s1, s2 []T) []T +``` + +Merge стабильное слияние двух слайсов + +## func MergeScalar + +```go +func MergeScalar[T utils.Scalar](s1, s2 []T) []T +``` + +MergeScalar стабильное слияние двух слайсов скаляров + +# levenshtein + +```go +import "go.neonxp.dev/extra/levenshtein" +``` + +Пакет с функциями получения редакторских правок по Левенштейну + +## Index + +- [type Edit](<#type-edit>) + - [func Levenshtein[T comparable](s1, s2 []T, cost EditCost[T]) []Edit](<#func-levenshtein>) + - [func String(s1, s2 string) []Edit](<#func-string>) + - [func Strings(s1, s2 []string) []Edit](<#func-strings>) +- [type EditCost](<#type-editcost>) +- [type EditType](<#type-edittype>) + + +## type Edit + +Edit редакторская правка описывающее одно действие над исходной последовательностью + +```go +type Edit struct { + Type EditType // Тип правки: Вставка/Замена/Удаление + Idx1 int // Индекс элемента из первой последовательности + Idx2 int // Индекс элемента из второй последовательности +} +``` + +### func Levenshtein + +```go +func Levenshtein[T comparable](s1, s2 []T, cost EditCost[T]) []Edit +``` + +Levenshtein возвращает последовательность правок для превращения последовательности элементов s1 в s2 с учетом стоимостей операций возвращаемых функцией cost TODO в алгоритме не предусмотрена экономия памяти ¯\\\_\(ツ\)\_/¯ + +### func String + +```go +func String(s1, s2 string) []Edit +``` + +String возвращает последовательность правок для превращения строки s1 в строку s2 + +### func Strings + +```go +func Strings(s1, s2 []string) []Edit +``` + +Strings возвращает последовательность правок для превращения слайса строк s1 в слайс строк s2 + +## type EditCost + +EditCost функция возвращающая стоимость действия t над элементами from\, to + +```go +type EditCost[T comparable] func(t EditType, from *T, to *T) int +``` + +## type EditType + +EditType тип правки + +```go +type EditType int +``` + +```go +const ( + Insert EditType = iota // Вставка + Replace // Замена + Delete // Удаление +) +``` + +# math + +```go +import "go.neonxp.dev/extra/math" +``` + +Пакет с математическими функциями над обобщенными типами + +## Index + +- [func Max[T utils.Sortable[T]](a ...T) T](<#func-max>) +- [func MaxScalar[T utils.Scalar](a ...T) T](<#func-maxscalar>) +- [func Min[T utils.Sortable[T]](a ...T) T](<#func-min>) +- [func MinScalar[T utils.Scalar](a ...T) T](<#func-minscalar>) + + +## func Max + +```go +func Max[T utils.Sortable[T]](a ...T) T +``` + +Max возвращает максимальное из переданных Sortable значений + +## func MaxScalar + +```go +func MaxScalar[T utils.Scalar](a ...T) T +``` + +MaxScalar возвращает максимальное из переданных скалярных значений + +## func Min + +```go +func Min[T utils.Sortable[T]](a ...T) T +``` + +Min возвращает минимальное из переданных Sortable значений + +## func MinScalar + +```go +func MinScalar[T utils.Scalar](a ...T) T +``` + +MinScalar возвращает минимальное из переданных скалярных значений + +# subseq + +```go +import "go.neonxp.dev/extra/subseq" +``` + +Пакет с функциями получения подпоследовательностей \(например\, подстроки\) + +## Index + +- [func MaxSubsequence(s1, s2 string) string](<#func-maxsubsequence>) +- [func MaxSubset[T comparable](s1, s2 []T) []T](<#func-maxsubset>) +- [func MaxSubsetSequence[T comparable](s1, s2 []T) []T](<#func-maxsubsetsequence>) +- [func MaxSubstring(s1, s2 string) string](<#func-maxsubstring>) + + +## func MaxSubsequence + +```go +func MaxSubsequence(s1, s2 string) string +``` + +MaxSubsequence возвращает максимальную общую подпоследовательность символов + +## func MaxSubset + +```go +func MaxSubset[T comparable](s1, s2 []T) []T +``` + +## func MaxSubsetSequence + +```go +func MaxSubsetSequence[T comparable](s1, s2 []T) []T +``` + +## func MaxSubstring + +```go +func MaxSubstring(s1, s2 string) string +``` + +MaxSubstring возвращаает максимальную общую подстроку + +# utils + +```go +import "go.neonxp.dev/extra/utils" +``` + +Всякое разное + +## Index + +- [func Ptr[T any](t T) *T](<#func-ptr>) +- [type Scalar](<#type-scalar>) +- [type Sortable](<#type-sortable>) + + +## func Ptr + +```go +func Ptr[T any](t T) *T +``` + +Ptr получение указателя от произвольного значения\, например\, ToPtr\(true\) \-\> \*bool\(true\) + +## type Scalar + +Scalar соответствует скалярам над которыми определены операции сравнения + +```go +type Scalar interface { + // contains filtered or unexported methods +} +``` + +## type Sortable + +Sortable соответствует типам над которыми определена операция Less + +```go +type Sortable[T any] interface { + Less(T) bool +} +``` + + + +Generated by [gomarkdoc]() diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..748d10c --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module go.neonxp.dev/extra + +go 1.18 diff --git a/levenshtein/doc.go b/levenshtein/doc.go new file mode 100644 index 0000000..a9d3130 --- /dev/null +++ b/levenshtein/doc.go @@ -0,0 +1,2 @@ +// Пакет с функциями получения редакторских правок по Левенштейну +package levenshtein diff --git a/levenshtein/generic.go b/levenshtein/generic.go new file mode 100644 index 0000000..4aa3ecf --- /dev/null +++ b/levenshtein/generic.go @@ -0,0 +1,99 @@ +package levenshtein + +import ( + "go.neonxp.dev/extra/math" +) + +// Levenshtein возвращает последовательность правок для превращения последовательности элементов s1 в s2 +// с учетом стоимостей операций возвращаемых функцией cost +// TODO в алгоритме не предусмотрена экономия памяти ¯\_(ツ)_/¯ +func Levenshtein[T comparable](s1, s2 []T, cost EditCost[T]) []Edit { + len1 := len(s1) + len2 := len(s2) + if cost == nil { + cost = EditCost[T](func(t EditType, s1 *T, s2 *T) int { + return 1 + }) + } + + dp := make([][]int, len1+1) + for i := range dp { + dp[i] = make([]int, len2+1) + } + dp[0][0] = 0 + for i := 0; i < len1; i++ { + for j := 0; j < len2; j++ { + if i == 0 && j == 0 { + continue + } + switch { + case i == 0: + dp[0][j] = dp[0][j-1] + cost(Insert, nil, &s2[j]) + case j == 0: + dp[i][0] = dp[i-1][0] + cost(Delete, &s1[i], nil) + default: + m1 := dp[i-1][j] + cost(Delete, &s1[i], nil) + m2 := dp[i][j-1] + cost(Insert, nil, &s2[j]) + m3 := dp[i-1][j-1] + cost(Replace, &s1[i], &s2[j]) + dp[i][j] = math.MinScalar(m1, m2, m3) + } + } + } + i, j := len1-1, len2-1 + edits := []Edit{} + for i > 0 && j > 0 { + m1 := dp[i-1][j] + cost(Delete, &s1[i], nil) + m2 := dp[i][j-1] + cost(Insert, nil, &s2[j]) + m3 := dp[i-1][j-1] + cost(Replace, &s1[i], &s2[j]) + min := math.MinScalar(m1, m2, m3) + if min == m1 { + // добавляем удаление символа S1[i] + edits = append(edits, Edit{ + Type: Delete, + Idx1: i, + }) + i-- + } + if min == m2 { + // добавляем вставку символа S2[j] после S1[i] + edits = append(edits, Edit{ + Type: Insert, + Idx1: i, + Idx2: j, + }) + j-- + } + if min == m3 { + // добавляем замену S1[i] на S2[j] + i-- + j-- + if s1[i] != s2[j] { + edits = append(edits, Edit{ + Type: Replace, + Idx1: i, + Idx2: j, + }) + } + } + } + return edits +} + +// EditCost функция возвращающая стоимость действия t над элементами from, to +type EditCost[T comparable] func(t EditType, from *T, to *T) int + +// Edit редакторская правка описывающее одно действие над исходной последовательностью +type Edit struct { + Type EditType // Тип правки: Вставка/Замена/Удаление + Idx1 int // Индекс элемента из первой последовательности + Idx2 int // Индекс элемента из второй последовательности +} + +// EditType тип правки +type EditType int + +const ( + Insert EditType = iota // Вставка + Replace // Замена + Delete // Удаление +) diff --git a/levenshtein/generic_test.go b/levenshtein/generic_test.go new file mode 100644 index 0000000..11c9611 --- /dev/null +++ b/levenshtein/generic_test.go @@ -0,0 +1,115 @@ +package levenshtein + +import ( + "reflect" + "testing" +) + +func TestLevenshtein2(t *testing.T) { + type args struct { + s1 []myType + s2 []myType + cost EditCost[myType] + } + tests := []struct { + name string + args args + want []Edit + }{ + { + name: "test1", + args: args{ + s1: []myType{ + { + a: "a", + }, { + a: "b", + }, { + a: "c", + }, + }, + s2: []myType{ + { + a: "a", + }, { + a: "d", + }, { + a: "c", + }, + }, + cost: EditCost[myType](func(t EditType, from, to *myType) int { + return 1 + }), + }, + want: []Edit{ + { + Type: Replace, + Idx1: 1, + Idx2: 1, + }, + }, + }, + { + name: "test2 - costly replace", + args: args{ + s1: []myType{ + { + a: "a", + }, { + a: "b", + }, { + a: "c", + }, + }, + s2: []myType{ + { + a: "a", + }, { + a: "d", + }, { + a: "c", + }, + }, + cost: EditCost[myType](func(t EditType, from, to *myType) int { + if t == Replace { + return 100 + } + return 1 + }), + }, + want: []Edit{ + { + Type: Delete, + Idx1: 2, + Idx2: 0, + }, + { + Type: Insert, + Idx1: 1, + Idx2: 2, + }, + { + Type: Delete, + Idx1: 1, + Idx2: 0, + }, + { + Type: Insert, + Idx1: 0, + Idx2: 1, + }, + }, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := Levenshtein(tt.args.s1, tt.args.s2, tt.args.cost); !reflect.DeepEqual(got, tt.want) { + t.Errorf("Levenshtein() = %v, want %v", got, tt.want) + } + }) + } +} + +type myType struct { + a string +} diff --git a/levenshtein/strings.go b/levenshtein/strings.go new file mode 100644 index 0000000..a6257d1 --- /dev/null +++ b/levenshtein/strings.go @@ -0,0 +1,11 @@ +package levenshtein + +// String возвращает последовательность правок для превращения строки s1 в строку s2 +func String(s1, s2 string) []Edit { + return Levenshtein([]rune(s1), []rune(s2), nil) +} + +// Strings возвращает последовательность правок для превращения слайса строк s1 в слайс строк s2 +func Strings(s1, s2 []string) []Edit { + return Levenshtein(s1, s2, nil) +} diff --git a/levenshtein/strings_test.go b/levenshtein/strings_test.go new file mode 100644 index 0000000..fe103e4 --- /dev/null +++ b/levenshtein/strings_test.go @@ -0,0 +1,64 @@ +package levenshtein + +import ( + "reflect" + "testing" +) + +func TestString(t *testing.T) { + type args struct { + s1 string + s2 string + } + tests := []struct { + name string + args args + want []Edit + }{ + { + name: "test1", + args: args{ + s1: "абвзгде", + s2: "абвжгде", + }, + want: []Edit{ + { + Type: Replace, + Idx1: 3, + Idx2: 3, + }, + }, + }, + { + name: "test2", + args: args{ + s1: "абавзгд", + s2: "абввжгде", + }, + want: []Edit{ + { + Type: Insert, // абавзгд -> абавзгд[е] + Idx1: 6, + Idx2: 7, + }, + { + Type: Replace, // абав[з]где -> абав[ж]где + Idx1: 4, + Idx2: 4, + }, + { + Type: Replace, // аб[а]вжгде -> аб[в]вжгде + Idx1: 2, + Idx2: 2, + }, + }, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := String(tt.args.s1, tt.args.s2); !reflect.DeepEqual(got, tt.want) { + t.Errorf("LevenshteinString() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/math/doc.go b/math/doc.go new file mode 100644 index 0000000..1d3cbf5 --- /dev/null +++ b/math/doc.go @@ -0,0 +1,2 @@ +// Пакет с математическими функциями над обобщенными типами +package math diff --git a/math/mimax.go b/math/mimax.go new file mode 100644 index 0000000..546afba --- /dev/null +++ b/math/mimax.go @@ -0,0 +1,63 @@ +package math + +import "go.neonxp.dev/extra/utils" + +// MinScalar возвращает минимальное из переданных скалярных значений +func MinScalar[T utils.Scalar](a ...T) T { + i := -1 + for j, v := range a { + if i == -1 { + i = j + continue + } + if v < a[i] { + i = j + } + } + return a[i] +} + +// MaxScalar возвращает максимальное из переданных скалярных значений +func MaxScalar[T utils.Scalar](a ...T) T { + i := -1 + for j, v := range a { + if i == -1 { + i = j + continue + } + if v > a[i] { + i = j + } + } + return a[i] +} + +// Min возвращает минимальное из переданных Sortable значений +func Min[T utils.Sortable[T]](a ...T) T { + i := -1 + for j, v := range a { + if i == -1 { + i = j + continue + } + if v.Less(a[i]) { + i = j + } + } + return a[i] +} + +// Max возвращает максимальное из переданных Sortable значений +func Max[T utils.Sortable[T]](a ...T) T { + i := -1 + for j, v := range a { + if i == -1 { + i = j + continue + } + if a[i].Less(v) { + i = j + } + } + return a[i] +} diff --git a/math/minmax_test.go b/math/minmax_test.go new file mode 100644 index 0000000..00211e2 --- /dev/null +++ b/math/minmax_test.go @@ -0,0 +1,58 @@ +package math + +import ( + "reflect" + "testing" +) + +func TestMin(t *testing.T) { + type args struct { + a []int + } + tests := []struct { + name string + args args + want int + }{ + { + name: "test1", + args: args{ + a: []int{8, 3, 6}, + }, + want: 3, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := MinScalar(tt.args.a...); !reflect.DeepEqual(got, tt.want) { + t.Errorf("Min() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestMax(t *testing.T) { + type args struct { + a []int + } + tests := []struct { + name string + args args + want int + }{ + { + name: "test1", + args: args{ + a: []int{8, 13, 6}, + }, + want: 13, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := MaxScalar(tt.args.a...); !reflect.DeepEqual(got, tt.want) { + t.Errorf("Max() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/readme.md b/readme.md new file mode 100755 index 0000000..ca65aeb --- /dev/null +++ b/readme.md @@ -0,0 +1,11 @@ +# Extra + +Пакет с разными полезными функциями без дополнительных зависимостей. + +Большинство функций написаны с использованием обобщенных типов. Другие - вызовы этих же функций с конкретными типами для упрощения использования. + +[Документация](/doc.md) + +Лицензия [GPL-3](https://antirao.ru/gpltrans/gplru.pdf) + +Автор: Александр Кирюхин diff --git a/subseq/doc.go b/subseq/doc.go new file mode 100644 index 0000000..4e4282c --- /dev/null +++ b/subseq/doc.go @@ -0,0 +1,2 @@ +// Пакет с функциями получения подпоследовательностей (например, подстроки) +package subseq diff --git a/subseq/generic.go b/subseq/generic.go new file mode 100644 index 0000000..4415ffb --- /dev/null +++ b/subseq/generic.go @@ -0,0 +1,80 @@ +package subseq + +func MaxSubset[T comparable](s1, s2 []T) []T { + len1 := len(s1) + len2 := len(s2) + + dp := make([][]int, len1+1) + for i := range dp { + dp[i] = make([]int, len2+1) + } + max := 0 + u := 0 + for i := 0; i < len1; i++ { + for j := 0; j < len2; j++ { + switch { + case i == 0: + dp[0][j] = 0 + case j == 0: + dp[i][0] = 0 + case s1[i] != s2[j]: + dp[i][j] = 0 + default: + dp[i][j] = dp[i-1][j-1] + 1 + if dp[i][j] > max { + max = dp[i][j] + u = i + } + } + } + } + ret := []T{} + for i := max; i > 0; i-- { + ret = append(ret, s1[u-i+1]) + } + return ret +} + +func MaxSubsetSequence[T comparable](s1, s2 []T) []T { + len1 := len(s1) + len2 := len(s2) + + dp := make([][]int, len1+1) + for i := range dp { + dp[i] = make([]int, len2+1) + } + + for i := len1; i >= 0; i-- { + for j := len2; j >= 0; j-- { + switch { + case i == len1, j == len2: + dp[i][j] = 0 + case s1[i] == s2[j]: + dp[i][j] = 1 + dp[i+1][j+1] + default: + max := dp[i+1][j] + if dp[i][j+1] > max { + max = dp[i][j+1] + } + dp[i][j] = max + } + } + } + + ret := []T{} + i, j := 0, 0 + for i < len1 && j < len2 { + switch { + case s1[i] == s2[j]: + ret = append(ret, s1[i]) + i++ + j++ + case dp[i+1][j] >= dp[i][j+1]: + i++ + default: + j++ + } + } + + return ret +} diff --git a/subseq/strings.go b/subseq/strings.go new file mode 100644 index 0000000..6be73e9 --- /dev/null +++ b/subseq/strings.go @@ -0,0 +1,11 @@ +package subseq + +// MaxSubstring возвращаает максимальную общую подстроку +func MaxSubstring(s1, s2 string) string { + return string(MaxSubset([]rune(s1), []rune(s2))) +} + +// MaxSubsequence возвращает максимальную общую подпоследовательность символов +func MaxSubsequence(s1, s2 string) string { + return string(MaxSubsetSequence([]rune(s1), []rune(s2))) +} diff --git a/subseq/strings_test.go b/subseq/strings_test.go new file mode 100644 index 0000000..b35b139 --- /dev/null +++ b/subseq/strings_test.go @@ -0,0 +1,77 @@ +package subseq + +import ( + "testing" +) + +func TestMaxSubstring(t *testing.T) { + type args struct { + s1 string + s2 string + } + tests := []struct { + name string + args args + want string + }{ + { + name: "test", + args: args{ + s1: "какая то строка текста", + s2: "другая строка другого", + }, + want: " строка ", + }, + { + name: "test2", + args: args{ + s1: "qwertyuiop", + s2: "asdfghertyjklzxcvzxqertyuvzvb", + }, + want: "ertyu", + }, + { + name: "empty", + args: args{ + s1: "abc", + s2: "def", + }, + want: "", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := MaxSubstring(tt.args.s1, tt.args.s2); got != tt.want { + t.Errorf("MaxSubstring() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestMaxSubseq(t *testing.T) { + type args struct { + s1 string + s2 string + } + tests := []struct { + name string + args args + want string + }{ + { + name: "test", + args: args{ + s1: "nematode knowledge", + s2: "empty bottle", + }, + want: "emt ole", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := MaxSubsequence(tt.args.s1, tt.args.s2); got != tt.want { + t.Errorf("MaxSubseq() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/utils/constraints.go b/utils/constraints.go new file mode 100644 index 0000000..c63ea63 --- /dev/null +++ b/utils/constraints.go @@ -0,0 +1,11 @@ +package utils + +// Scalar соответствует скалярам над которыми определены операции сравнения +type Scalar interface { + ~int | ~int8 | ~int16 | ~int32 | ~int64 | ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr | ~float32 | ~float64 | ~string +} + +// Sortable соответствует типам над которыми определена операция Less +type Sortable[T any] interface { + Less(T) bool +} diff --git a/utils/doc.go b/utils/doc.go new file mode 100644 index 0000000..9087888 --- /dev/null +++ b/utils/doc.go @@ -0,0 +1,2 @@ +// Всякое разное +package utils diff --git a/utils/ptr.go b/utils/ptr.go new file mode 100644 index 0000000..449f499 --- /dev/null +++ b/utils/ptr.go @@ -0,0 +1,6 @@ +package utils + +// Ptr получение указателя от произвольного значения, например, ToPtr(true) -> *bool(true) +func Ptr[T any](t T) *T { + return &t +}