diff --git a/.arcconfig b/.arcconfig new file mode 100644 index 0000000..618b0f8 --- /dev/null +++ b/.arcconfig @@ -0,0 +1,6 @@ +{ + "repository.callsign" : "AKAIT", + "phabricator.uri" : "https://c4science.ch/", + "history.immutable" : true, + "projects": "akantu-developers" +} diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..a42159b --- /dev/null +++ b/.clang-format @@ -0,0 +1,8 @@ +--- +Language: Cpp +BasedOnStyle: LLVM +Standard: Cpp11 +TabWidth: 4 +PointerAlignment: Middle +NamespaceIndentation: Inner +... diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 0000000..a0f6366 --- /dev/null +++ b/.clang-tidy @@ -0,0 +1,4 @@ +Checks: 'modernize-use-*, performance-*' +AnalyzeTemporaryDtors: false +HeaderFilterRegex: 'src/.*' +FormatStyle: file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4909aca --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +build* +third-party/*/ +TAG +*~ +.*.swp +*.tar.gz +*.tgz +*.tbz +*.tar.bz2 +.idea +__pycache__ +.mailmap +.dir-locals.el \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..3272d7d --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,69 @@ +cmake_minimum_required(VERSION 3.10) + +project(AkantuIterators) + +# ------------------------------------------------------------------------------ +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) +set(BUILD_SHARED_LIBS ON) +if (NOT AKANTU_ITERATORS_PYTHON_MAJOR_VERSION) + set(AKANTU_ITERATORS_PYTHON_MAJOR_VERSION 3) +endif() +set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR}/cmake) + +include(AkantuIteratorsTools) +# ------------------------------------------------------------------------------ + +set(AKANTU_ITERATORS_PUBLIC_HDRS + aka_compatibilty_with_cpp_standard.hh + aka_iterators.hh + aka_static_if.hh + aka_tuple_tools.hh + ) + +add_library(akantu_iterators INTERFACE) + +target_include_directories(akantu_iterators + INTERFACE $ + ) + +# small trick for build includes in public +set_property(TARGET akantu_iterators APPEND PROPERTY + INTERFACE_INCLUDE_DIRECTORIES $) + +set_property(TARGET akantu_iterators PROPERTY + INTERFACE_PUBLIC_HEADER ${AKANTU_ITERATORS_PUBLIC_HDRS}) + +set_target_properties(akantu_iterators + PROPERTIES + INTERFACE_CXX_STANDARD 14 + ) +# ------------------------------------------------------------------------------ + +option(AKANTU_ITERATORS_TESTS ON) +mark_as_advanced(AKANTU_ITERATORS_TESTS) +if(AKANTU_ITERATORS_TESTS) + enable_testing() + add_external_package(GTest) + add_subdirectory(test) +endif() + +# ------------------------------------------------------------------------------ +if(NOT AKANTU_ITERATORS_TARGETS_EXPORT) + set(AKANTU_ITERATORS_TARGETS_EXPORT AkantuIteratorsTargets) +endif() + +install(TARGETS akantu_iterators + EXPORT ${AKANTU_ITERATORS_TARGETS_EXPORT} + PUBLIC_HEADER DESTINATION include/akantu_iterators/ COMPONENT dev + ) + +if("${AKANTU_ITERATORS_TARGETS_EXPORT}" STREQUAL "AkantuIteratorsTargets") + install(EXPORT AkantuIteratorsTargets DESTINATION share/cmake/${PROJECT_NAME} + COMPONENT dev) + + #Export for build tree + export(EXPORT AkantuIteratorsTargets + FILE "${CMAKE_CURRENT_BINARY_DIR}/AkantuIteratorsTargets.cmake") + export(PACKAGE AkantuIterators) +endif() + diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -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/COPYING.lesser b/COPYING.lesser new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/COPYING.lesser @@ -0,0 +1,165 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/cmake/AkantuIteratorsTools.cmake b/cmake/AkantuIteratorsTools.cmake new file mode 100644 index 0000000..6933780 --- /dev/null +++ b/cmake/AkantuIteratorsTools.cmake @@ -0,0 +1,222 @@ +#============================================================================== +# file AkantuIterators.cmake +# +# @author Nicolas Richart +# +# @date 11 Jan 2018 +# +# @brief some tool to help to do stuff with cmake in AkantuIterators +# +# @section LICENSE +# +# Copyright © 2018 Till Junge +# +# µSpectre 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, or (at +# your option) any later version. +# +# µSpectre 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 µSpectre; see the file COPYING. If not, write to the +# Free Software Foundation, Inc., 59 Temple Place - Suite 330, +# Boston, MA 02111-1307, USA. +# + +#[=[.rst: +AkantuIteratorsTools +------------- + +This module provide some helper functions for AkantuIterators + +:: + +download_external_project(project_name + URL + BACKEND + [TAG ] + [THIRD_PARTY_SRC_DIR ] + [NO_UPDATE] + ) + +Downloads the external project based on the uri + +``THIRD_PARTY_SRC_DIR `` + Specifies where to download the source + +``NO_UPDATE`` + Does not try to update existing download + +:: + +mark_as_advanced_prefix(prefix) + +Marks as advanced all variables whoes names start with prefix + +:: + +add_external_dep(package + [IGNORE_SYSTEM] + [VERSION ] + [...]) + +Tries to find the external package and if not found but a local +${package}.cmake files exists, it includes it. The extra arguments are passed +to find_package() + +``IGNORE_SYSTEM`` does not do the find_package + +``VERSION`` Specifies the required minimum version + +]=] +# + +function(download_external_project project_name) + include(CMakeParseArguments) + + set(_dep_flags + NO_UPDATE) + set(_dep_one_variables + URL + TAG + BACKEND + THIRD_PARTY_SRC_DIR + ) + set(_dep_multi_variables) + cmake_parse_arguments(_dep_args + "${_dep_flags}" + "${_dep_one_variables}" + "${_dep_multi_variables}" + ${ARGN} + ) + + if(NOT _dep_args_URL) + message(FATAL_ERROR "You have to provide a URL for the project ${project_name}") + endif() + + if(NOT _dep_args_BACKEND) + message(FATAL_ERROR "You have to provide a backend to download ${project_name}") + endif() + + if(_dep_args_TAG) + set(_ep_tag "${_dep_args_BACKEND}_TAG ${_dep_args_TAG}") + endif() + + set(_src_dir ${PROJECT_SOURCE_DIR}/third-party/${project_name}) + if (_dep_args_THIRD_PARTY_SRC_DIR) + set(_src_dir ${_dep_args_THIRD_PARTY_SRC_DIR}/${project_name}) + endif() + + if(EXISTS ${_src_dir}/.DOWNLOAD_SUCCESS AND _dep_args_NO_UPDATE) + return() + endif() + + set(_working_dir ${PROJECT_BINARY_DIR}/third-party/${project_name}-download) + file(WRITE ${_working_dir}/CMakeLists.txt + " +cmake_minimum_required(VERSION 3.1) +project(${project_name}-download NONE) +include(ExternalProject) +ExternalProject_Add(${project_name} + SOURCE_DIR ${_src_dir} + BINARY_DIR ${_working_dir} + ${_dep_args_BACKEND}_REPOSITORY ${_dep_args_URL} + ${_ep_tag} + CONFIGURE_COMMAND \"\" + BUILD_COMMAND \"\" + INSTALL_COMMAND \"\" + TEST_COMMAND \"\" + ) +") + message(STATUS "Downloading ${project_name} ${_dep_args_GIT_TAG}") + execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" . + RESULT_VARIABLE _result + WORKING_DIRECTORY ${_working_dir} + OUTPUT_FILE ${_working_dir}/configure-out.log + ERROR_FILE ${_working_dir}/configure-error.log) + + if(_result) + message(FATAL_ERROR "Something went wrong (${_result}) during the download" + " process of ${project_name} check the file" + " ${_working_dir}/configure-error.log for more details:") + file(STRINGS "${_working_dir}/configure-error.log" ERROR_MSG) + message("${ERROR_MSG}") + endif() + + execute_process(COMMAND "${CMAKE_COMMAND}" --build . + RESULT_VARIABLE _result + WORKING_DIRECTORY ${_working_dir} + OUTPUT_FILE ${_working_dir}/build-out.log + ERROR_FILE ${_working_dir}/build-error.log) + + if(_result) + message(FATAL_ERROR "Something went wrong (${_result}) during the download" + " process of ${project_name} check the file" + " ${_working_dir}/build-error.log for more details") + endif() + + file(WRITE ${_src_dir}/.DOWNLOAD_SUCCESS "") +endfunction() + +# ------------------------------------------------------------------------------ +function(mark_as_advanced_prefix prefix) + get_property(_list DIRECTORY PROPERTY VARIABLES) + foreach(_var ${_list}) + if("${_var}" MATCHES "^${prefix}") + mark_as_advanced(${_var}) + endif() + endforeach() +endfunction() + +# ------------------------------------------------------------------------------ +function(add_external_package package) + include(CMakeParseArguments) + + set(_cmake_includes ${PROJECT_SOURCE_DIR}/cmake) + set(_${package}_external_dir ${PROJECT_SOURCE_DIR}/third-party) + + set(_aep_flags + IGNORE_SYSTEM + ) + set(_aep_one_variables + VERSION + ) + set(_aep_multi_variables) + + cmake_parse_arguments(_aep_args + "${_aep_flags}" + "${_aep_one_variables}" + "${_aep_multi_variables}" + ${ARGN} + ) + + if(_aep_args_VERSION) + set(_${package}_version ${_aep_args_VERSION}) + endif() + + if(NOT EXISTS ${_cmake_includes}/${package}.cmake) + set(_required REQUIRED) + endif() + + if(NOT _aep_args_IGNORE_SYSTEM) + find_package(${package} ${_${package}_version} ${_required} ${_aep_UNPARSED_ARGUMENTS} QUIET) + if(${package}_FOUND AND NOT ${package}_FOUND_EXTERNAL) + string(TOUPPER ${package} u_package) + mark_as_advanced_prefix(${package}) + mark_as_advanced_prefix(${u_package}) + return() + endif() + endif() + + if(EXISTS ${_cmake_includes}/${package}.cmake) + include(${_cmake_includes}/${package}.cmake) + endif() + + string(TOUPPER ${package} u_package) + mark_as_advanced_prefix(${package}) + mark_as_advanced_prefix(${u_package}) +endfunction() diff --git a/cmake/GTest.cmake b/cmake/GTest.cmake new file mode 100644 index 0000000..ec9be11 --- /dev/null +++ b/cmake/GTest.cmake @@ -0,0 +1,29 @@ +if(NOT _GTest_version) + set(_GTest_version "master") +endif() + +download_external_project(google-test + URL "https://github.com/google/googletest.git" + TAG "${_GTest_version}" + BACKEND GIT + THIRD_PARTY_SRC_DIR ${_GTest_external_dir} + ${_GTest_update} + ) + +set(gtest_build_tests OFF CACHE INTERNAL "" FORCE) +set(INSTALL_GTEST OFF CACHE INTERNAL "" FORCE) +set(BUILD_GTEST ON CACHE INTERNAL "" FORCE) +set(BUILD_GMOCK OFF CACHE INTERNAL "" FORCE) + +set(Python_ADDITIONAL_VERSIONS ${AKANTU_ITERATORS_PYTHON_MAJOR_VERSION}) + +add_subdirectory(${_GTest_external_dir}/google-test) + +set_property(TARGET gtest_main PROPERTY CXX_STANDARD 14) +set_property(TARGET gtest PROPERTY CXX_STANDARD 14) + +add_library(GTest::Main ALIAS gtest_main) +add_library(GTest::GTest ALIAS gtest) + +mark_as_advanced(INSTALL_GTEST) +mark_as_advanced_prefix(gtest) diff --git a/include/aka_compatibilty_with_cpp_standard.hh b/include/aka_compatibilty_with_cpp_standard.hh new file mode 100644 index 0000000..9ec345b --- /dev/null +++ b/include/aka_compatibilty_with_cpp_standard.hh @@ -0,0 +1,179 @@ +/** + * @file aka_compatibilty_with_cpp_standard.hh + * + * @author Nicolas Richart + * + * @date creation: Fri Jun 18 2010 + * @date last modification: Wed Jan 10 2018 + * + * @brief The content of this file is taken from the possible implementations + * on + * http://en.cppreference.com + * + * @section LICENSE + * + * Copyright (©) 2010-2018 EPFL (Ecole Polytechnique Fédérale de Lausanne) + * Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides) + * + * Akantu is free software: you can redistribute it and/or modify it under the + * terms of the GNU Lesser General Public License as published by the Free + * Software Foundation, either version 3 of the License, or (at your option) any + * later version. + * + * Akantu is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more + * details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Akantu. If not, see . + * + */ + +/* -------------------------------------------------------------------------- */ +#include "aka_static_if.hh" +/* -------------------------------------------------------------------------- */ +#include +#include +#include +/* -------------------------------------------------------------------------- */ + +#ifndef AKANTU_AKA_COMPATIBILTY_WITH_CPP_STANDARD_HH +#define AKANTU_AKA_COMPATIBILTY_WITH_CPP_STANDARD_HH + +namespace aka { + +/* -------------------------------------------------------------------------- */ +// Part taken from C++14 +#if __cplusplus < 201402L +template +using enable_if_t = typename enable_if::type; +#else +template using enable_if_t = std::enable_if_t; +#endif + +/* -------------------------------------------------------------------------- */ +// Part taken from C++17 +#if __cplusplus < 201703L + +/* -------------------------------------------------------------------------- */ +// bool_constant +template using bool_constant = std::integral_constant; +namespace { +template constexpr bool bool_constant_v = bool_constant::value; +} + +/* -------------------------------------------------------------------------- */ +// conjunction +template struct conjunction : std::true_type {}; +template struct conjunction : B1 {}; +template +struct conjunction + : std::conditional_t, B1> {}; + +/* -------------------------------------------------------------------------- */ +// disjunction +template struct disjunction : std::false_type {}; +template struct disjunction : B1 {}; +template +struct disjunction + : std::conditional_t> {}; + +/* -------------------------------------------------------------------------- */ +// negations +template struct negation : bool_constant {}; + +/* -------------------------------------------------------------------------- */ +// invoke +namespace detail { +template struct is_reference_wrapper : std::false_type {}; +template +struct is_reference_wrapper> : std::true_type {}; + +template +decltype(auto) INVOKE(Type T::*f, T1 &&t1, Args &&... args) { + static_if(std::is_member_function_pointer{}) + .then_([&](auto &&f) { + static_if(std::is_base_of>{}) + .then_([&](auto &&f) { + return (std::forward(t1).*f)(std::forward(args)...); + }) + .elseif(is_reference_wrapper>{})([&](auto &&f) { + return (t1.get().*f)(std::forward(args)...); + }) + .else_([&](auto &&f) { + return ((*std::forward(t1)).*f)(std::forward(args)...); + })(std::forward(f)); + }) + .else_([&](auto &&f) { + static_assert(std::is_member_object_pointer::value, + "f is not a member object"); + static_assert(sizeof...(args) == 0, "f takes arguments"); + static_if(std::is_base_of>{}) + .then_([&](auto &&f) { return std::forward(t1).*f; }) + .elseif(std::is_base_of>{})( + [&](auto &&f) { return t1.get().*f; }) + .else_([&](auto &&f) { return (*std::forward(t1)).*f; })( + std::forward(f)); + })(std::forward(f)); +} + +template +decltype(auto) INVOKE(F &&f, Args &&... args) { + return std::forward(f)(std::forward(args)...); +} +} // namespace detail + +template +decltype(auto) invoke(F &&f, Args &&... args) { + return detail::INVOKE(std::forward(f), std::forward(args)...); +} + +/* -------------------------------------------------------------------------- */ +// apply +namespace detail { +template +constexpr decltype(auto) apply_impl(F &&f, Tuple &&t, + std::index_sequence) { + return invoke(std::forward(f), std::get(std::forward(t))...); +} +} // namespace detail + +/* -------------------------------------------------------------------------- */ +template +constexpr decltype(auto) apply(F &&f, Tuple &&t) { + return detail::apply_impl( + std::forward(f), std::forward(t), + std::make_index_sequence>::value>{}); +} + +/* -------------------------------------------------------------------------- */ +// count_if +template +typename std::iterator_traits::difference_type +count_if(InputIt first, InputIt last, UnaryPredicate p) { + typename std::iterator_traits::difference_type ret = 0; + for (; first != last; ++first) { + if (p(*first)) { + ret++; + } + } + return ret; +} + +#else +template using bool_constant = std::bool_constant; +template using bool_constant_v = std::bool_constant_v; + +template using conjunction = std::conjunction; +template using disjunction = std::disjunction; +template using negation = std::negation; + +using invoke = std::invoke; +using apply = std::apply; + +using count_if = std::count_if; +#endif +} // namespace aka + +#endif /* AKANTU_AKA_COMPATIBILTY_WITH_CPP_STANDARD_HH */ diff --git a/include/aka_iterators.hh b/include/aka_iterators.hh new file mode 100644 index 0000000..bcff1ba --- /dev/null +++ b/include/aka_iterators.hh @@ -0,0 +1,693 @@ +/** + * @file aka_iterators.hh + * + * @author Nicolas Richart + * + * @date creation: Fri Aug 11 2017 + * @date last modification: Mon Jan 29 2018 + * + * @brief iterator interfaces + * + * @section LICENSE + * + * Copyright (©) 2016-2018 EPFL (Ecole Polytechnique Fédérale de Lausanne) + * Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides) + * + * Akantu is free software: you can redistribute it and/or modify it under the + * terms of the GNU Lesser General Public License as published by the Free + * Software Foundation, either version 3 of the License, or (at your option) any + * later version. + * + * Akantu is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more + * details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Akantu. If not, see . + * + */ + +/* -------------------------------------------------------------------------- */ +#include "aka_compatibilty_with_cpp_standard.hh" +#include "aka_tuple_tools.hh" +/* -------------------------------------------------------------------------- */ +#include +#include +#include + +/* -------------------------------------------------------------------------- */ +#ifndef AKANTU_AKA_ITERATORS_HH +#define AKANTU_AKA_ITERATORS_HH + +#ifndef AKANTU_ITERATOR_NAMESPACE +#define AKANTU_ITERATOR_NAMESPACE akantu +#endif + +namespace AKANTU_ITERATOR_NAMESPACE { + +/* -------------------------------------------------------------------------- */ +namespace iterators { + namespace details { + template + using is_iterator_category_at_least = + std::is_same, cat2>; + } + + template class ZipIterator { + private: + using tuple_t = std::tuple; + + public: + using value_type = + std::tuple::value_type...>; + using difference_type = std::common_type_t< + typename std::iterator_traits::difference_type...>; + using pointer = + std::tuple::pointer...>; + using reference = + std::tuple::reference...>; + using iterator_category = // std::input_iterator_tag; + std::common_type_t< + typename std::iterator_traits::iterator_category...>; + + using nb_iterators = std::tuple_size; + + public: + explicit ZipIterator(tuple_t iterators) : iterators(std::move(iterators)) {} + + ZipIterator(const ZipIterator & other) = default; + ZipIterator(ZipIterator && other) noexcept = default; + + ZipIterator & operator=(const ZipIterator & other) = default; + ZipIterator & operator=(ZipIterator && other) noexcept = default; + + /* ---------------------------------------------------------------------- */ + template ::value> * = nullptr> + ZipIterator & operator--() { + tuple::foreach ([](auto && it) { --it; }, iterators); + return *this; + } + + template ::value> * = nullptr> + ZipIterator operator--(int a) { + auto cpy = *this; + this->operator--(); + return cpy; + } + + // input iterator ++it + ZipIterator & operator++() { + tuple::foreach ([](auto && it) { ++it; }, iterators); + return *this; + } + + // input iterator it++ + ZipIterator operator++(int) { + auto cpy = *this; + this->operator++(); + return cpy; + } + + // input iterator it != other_it + bool operator!=(const ZipIterator & other) const { + // return tuple::are_not_equal(iterators, other.iterators); + return std::get<0>(iterators) != + std::get<0>(other.iterators); // helps the compiler to optimize + } + + // input iterator dereference *it + decltype(auto) operator*() { + return tuple::transform([](auto && it) -> decltype(auto) { return *it; }, + iterators); + } + + template ::value> * = nullptr> + difference_type operator-(const ZipIterator & other) { + return std::get<0>(this->iterators) - std::get<0>(other.iterators); + } + + // random iterator it[idx] + template ::value> * = nullptr> + decltype(auto) operator[](std::size_t idx) { + return tuple::transform( + [idx](auto && it) -> decltype(auto) { return it[idx]; }, iterators); + } + + // random iterator it + n + template ::value> * = nullptr> + decltype(auto) operator+(std::size_t n) { + return ZipIterator(std::forward(tuple::transform( + [n](auto && it) -> decltype(auto) { return it + n; }, iterators))); + } + + // random iterator it - n + template ::value> * = nullptr> + decltype(auto) operator-(std::size_t n) { + return ZipIterator(std::forward(tuple::transform( + [n](auto && it) -> decltype(auto) { return it - n; }, iterators))); + } + + template < + class iterator_category_ = iterator_category, + std::enable_if_t::value> * = nullptr> + bool operator==(const ZipIterator & other) const { + return not tuple::are_not_equal(iterators, other.iterators); + } + + private: + tuple_t iterators; + }; +} // namespace iterators + +/* -------------------------------------------------------------------------- */ +template +decltype(auto) zip_iterator(std::tuple && iterators_tuple) { + auto zip = iterators::ZipIterator( + std::forward(iterators_tuple)); + return zip; +} + +/* -------------------------------------------------------------------------- */ +namespace containers { + template class ZipContainer { + using containers_t = std::tuple; + + public: + explicit ZipContainer(Containers &&... containers) + : containers(std::forward(containers)...) {} + + decltype(auto) begin() const { + return zip_iterator( + tuple::transform([](auto && c) { return c.begin(); }, + std::forward(containers))); + } + + decltype(auto) end() const { + return zip_iterator( + tuple::transform([](auto && c) { return c.end(); }, + std::forward(containers))); + } + + decltype(auto) begin() { + return zip_iterator( + tuple::transform([](auto && c) { return c.begin(); }, + std::forward(containers))); + } + + decltype(auto) end() { + return zip_iterator( + tuple::transform([](auto && c) { return c.end(); }, + std::forward(containers))); + } + + // template , + // std::enable_if_t().size())>::value> * = nullptr> + // decltype(auto) size() { + // return std::forward(std::get<0>(containers)).size(); + // } + + private: + containers_t containers; + }; + + template class Range { + public: + using iterator = Iterator; + // ugly trick + using const_iterator = Iterator; + + explicit Range(Iterator && it1, Iterator && it2) + : iterators(std::forward(it1), std::forward(it2)) {} + + decltype(auto) begin() const { return std::get<0>(iterators); } + decltype(auto) begin() { return std::get<0>(iterators); } + + decltype(auto) end() const { return std::get<1>(iterators); } + decltype(auto) end() { return std::get<1>(iterators); } + + private: + std::tuple iterators; + }; +} // namespace containers + +/* -------------------------------------------------------------------------- */ +template decltype(auto) zip(Containers &&... conts) { + return containers::ZipContainer( + std::forward(conts)...); +} + +template +decltype(auto) range(Iterator && it1, Iterator && it2) { + return containers::Range(std::forward(it1), + std::forward(it2)); +} +/* -------------------------------------------------------------------------- */ +/* Arange */ +/* -------------------------------------------------------------------------- */ +namespace iterators { + template class ArangeIterator { + public: + using value_type = T; + using pointer = T *; + using reference = T &; + using difference_type = size_t; + using iterator_category = std::forward_iterator_tag; + + constexpr ArangeIterator(T value, T step) : value(value), step(step) {} + constexpr ArangeIterator(const ArangeIterator &) = default; + + constexpr ArangeIterator & operator++() { + value += step; + return *this; + } + + constexpr T operator*() const { return value; } + + constexpr bool operator==(const ArangeIterator & other) const { + return (value == other.value) and (step == other.step); + } + + constexpr bool operator!=(const ArangeIterator & other) const { + return not operator==(other); + } + + private: + T value{0}; + const T step{1}; + }; +} // namespace iterators + +namespace containers { + template class ArangeContainer { + public: + using iterator = iterators::ArangeIterator; + using const_iterator = iterators::ArangeIterator; + + constexpr ArangeContainer(T start, T stop, T step = 1) + : start(start), stop((stop - start) % step == 0 + ? stop + : start + (1 + (stop - start) / step) * step), + step(step) {} + explicit constexpr ArangeContainer(T stop) : ArangeContainer(0, stop, 1) {} + + constexpr T operator[](size_t i) { + T val = start + i * step; + assert(val < stop && "i is out of range"); + return val; + } + + constexpr T size() { return (stop - start) / step; } + + constexpr iterator begin() { return iterator(start, step); } + constexpr iterator end() { return iterator(stop, step); } + + private: + const T start{0}, stop{0}, step{1}; + }; +} // namespace containers + +template >::value>> +inline decltype(auto) arange(const T & stop) { + return containers::ArangeContainer(stop); +} + +template >::value>> +inline constexpr decltype(auto) arange(const T1 & start, const T2 & stop) { + return containers::ArangeContainer>(start, stop); +} + +template >::value>> +inline constexpr decltype(auto) arange(const T1 & start, const T2 & stop, + const T3 & step) { + return containers::ArangeContainer>( + start, stop, step); +} + +/* -------------------------------------------------------------------------- */ +namespace iterators { + template class EnumerateIterator { + public: + using value_type = + std::tuple::value_type>; + using difference_type = size_t; + using pointer = + std::tuple::pointer>; + using reference = + std::tuple::reference>; + using iterator_category = std::input_iterator_tag; + + public: + explicit EnumerateIterator(Iterator && iterator) : iterator(iterator) {} + + // input iterator ++it + EnumerateIterator & operator++() { + ++iterator; + ++index; + return *this; + } + + // input iterator it++ + EnumerateIterator operator++(int) { + auto cpy = *this; + this->operator++(); + return cpy; + } + + // input iterator it != other_it + bool operator!=(const EnumerateIterator & other) const { + return iterator != other.iterator; + } + + // input iterator dereference *it + decltype(auto) operator*() { + return std::tuple_cat(std::make_tuple(index), *iterator); + } + + bool operator==(const EnumerateIterator & other) const { + return not this->operator!=(other); + } + + private: + Iterator iterator; + size_t index{0}; + }; + + template + inline constexpr decltype(auto) enumerate(Iterator && iterator) { + return EnumerateIterator(std::forward(iterator)); + } + +} // namespace iterators + +namespace containers { + template class EnumerateContainer { + public: + explicit EnumerateContainer(Containers &&... containers) + : zip_container(std::forward(containers)...) {} + + decltype(auto) begin() { + return iterators::enumerate(zip_container.begin()); + } + + decltype(auto) begin() const { + return iterators::enumerate(zip_container.begin()); + } + + decltype(auto) end() { return iterators::enumerate(zip_container.end()); } + + decltype(auto) end() const { + return iterators::enumerate(zip_container.end()); + } + + private: + ZipContainer zip_container; + }; +} // namespace containers + +template +inline constexpr decltype(auto) enumerate(Container &&... container) { + return containers::EnumerateContainer( + std::forward(container)...); +} + +/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------------- */ +namespace iterators { + template + class transform_adaptor_iterator { + public: + using value_type = decltype(std::declval()( + std::declval())); + using difference_type = typename iterator_t::difference_type; + using pointer = std::decay_t *; + using reference = value_type &; + using iterator_category = typename iterator_t::iterator_category; + + transform_adaptor_iterator(iterator_t it, operator_t op) + : it(std::move(it)), op(op) {} + transform_adaptor_iterator(const transform_adaptor_iterator &) = default; + + transform_adaptor_iterator & operator++() { + ++it; + return *this; + } + + decltype(auto) operator*() { return op(std::forward(*it)); } + + bool operator==(const transform_adaptor_iterator & other) const { + return (it == other.it); + } + + bool operator!=(const transform_adaptor_iterator & other) const { + return not operator==(other); + } + + template ::value> * = nullptr> + difference_type operator-(const transform_adaptor_iterator & other) { + return other - *this; + } + + private: + iterator_t it; + operator_t op; + }; + + template + decltype(auto) make_transform_adaptor_iterator(iterator_t it, operator_t op) { + return transform_adaptor_iterator( + it, std::forward(op)); + } + +} // namespace iterators + +namespace containers { + template + class TransformIteratorAdaptor { + public: + // using const_iterator = typename + // std::decay_t::const_iterator; using iterator = typename + // std::decay_t::iterator; + + TransformIteratorAdaptor(container_t && cont, operator_t op) + : cont(std::forward(cont)), + op(std::forward(op)) {} + + decltype(auto) begin() const { + return iterators::make_transform_adaptor_iterator(cont.begin(), op); + } + decltype(auto) begin() { + return iterators::make_transform_adaptor_iterator(cont.begin(), op); + } + + decltype(auto) end() const { + return iterators::make_transform_adaptor_iterator(cont.end(), op); + } + decltype(auto) end() { + return iterators::make_transform_adaptor_iterator(cont.end(), op); + } + + private: + container_t cont; + operator_t op; + }; +} // namespace containers + +template +decltype(auto) make_transform_adaptor(container_t && cont, operator_t && op) { + return containers::TransformIteratorAdaptor( + std::forward(cont), std::forward(op)); +} + +template +decltype(auto) make_keys_adaptor(container_t && cont) { + return make_transform_adaptor( + std::forward(cont), + [](auto && pair) -> const auto & { return pair.first; }); +} + +template +decltype(auto) make_values_adaptor(container_t && cont) { + return make_transform_adaptor( + std::forward(cont), + [](auto && pair) -> auto & { return pair.second; }); +} + +template +decltype(auto) make_dereference_adaptor(container_t && cont) { + return make_transform_adaptor( + std::forward(cont), + [](auto && value) -> decltype(*value) { return *value; }); +} + +template +decltype(auto) make_zip_cat(zip_container_t &&... cont) { + return make_transform_adaptor( + zip(std::forward(cont)...), + [](auto && value) { return tuple::flatten(value); }); +} + +/* -------------------------------------------------------------------------- */ +namespace iterators { + template + class FilterIterator { + public: + using value_type = + decltype(std::declval().operator[](0)); + using difference_type = typename filter_iterator_t::difference_type; + using pointer = std::decay_t *; + using reference = value_type &; + using iterator_category = typename filter_iterator_t::iterator_category; + + FilterIterator(filter_iterator_t && filter_it, + container_iterator_t && container_begin) + : filter_it(std::forward(filter_it)), + container_begin(std::forward(container_begin)), + container_it(container_begin) {} + + FilterIterator(const FilterIterator &) = default; + + FilterIterator & operator++() { + ++filter_it; + container_it = + container_begin + *filter_it; // this might return invalid iterators + return *this; + } + + template * = nullptr> + decltype(auto) operator*() { + return std::get<0>(*container_it); + } + + template * = nullptr> + decltype(auto) operator*() { + return *container_it; + } + + template * = nullptr> + decltype(auto) operator*() const { + return std::get<0>(*container_it); + } + + template * = nullptr> + decltype(auto) operator*() const { + return *container_it; + } + + bool operator==(const FilterIterator & other) const { + return (filter_it == other.filter_it) and + (container_begin == other.container_begin); + } + + bool operator!=(const FilterIterator & other) const { + return filter_it != other.filter_it; + } + + private: + filter_iterator_t filter_it; + container_iterator_t container_begin; + container_iterator_t container_it; + }; + + template + decltype(auto) make_filter_iterator(filter_iterator_t && filter_it, + container_iterator_t && container_begin) { + return FilterIterator( + std::forward(filter_it), + std::forward(container_begin)); + } +} // namespace iterators + +namespace containers { + template class FilterAdaptor { + public: + FilterAdaptor(filter_t && filter, Containers &&... containers) + : filter(std::forward(filter)), + zip_container(std::forward(containers)...) { + static_assert(std::is_same::value, + "Containers must all have random iterators"); + } + + decltype(auto) begin() const { + return iterators::make_filter_iterator(filter.begin(), + zip_container.begin()); + } + decltype(auto) begin() { + return iterators::make_filter_iterator(filter.begin(), + zip_container.begin()); + } + + decltype(auto) end() const { + return iterators::make_filter_iterator(filter.end(), + zip_container.begin()); + } + decltype(auto) end() { + return iterators::make_filter_iterator(filter.end(), + zip_container.begin()); + } + + private: + filter_t filter; + ZipContainer zip_container; + }; +} // namespace containers + +template +decltype(auto) make_filtered_adaptor(filter_t && filter, + Containers &&... containers) { + return containers::FilterAdaptor( + std::forward(filter), std::forward(containers)...); +} + +} // namespace AKANTU_ITERATOR_NAMESPACE + +namespace std { +template +struct iterator_traits<::akantu::iterators::ZipIterator> { + using iterator_category = forward_iterator_tag; + using value_type = + typename ::akantu::iterators::ZipIterator::value_type; + using difference_type = + typename ::akantu::iterators::ZipIterator::difference_type; + using pointer = typename ::akantu::iterators::ZipIterator::pointer; + using reference = + typename ::akantu::iterators::ZipIterator::reference; +}; + +} // namespace std + +#endif /* AKANTU_AKA_ITERATORS_HH */ diff --git a/include/aka_static_if.hh b/include/aka_static_if.hh new file mode 100644 index 0000000..7264f4d --- /dev/null +++ b/include/aka_static_if.hh @@ -0,0 +1,98 @@ +// Copyright (c) 2016 Vittorio Romeo +// License: AFL 3.0 | https://opensource.org/licenses/AFL-3.0 +// http://vittorioromeo.info | vittorio.romeo@outlook.com + +#ifndef AKANTU_AKA_STATIC_IF_HH +#define AKANTU_AKA_STATIC_IF_HH + +#ifndef AKANTU_ITERATOR_NAMESPACE +#define AKANTU_ITERATOR_NAMESPACE akantu +#endif + +#include + +#define FWD(...) ::std::forward(__VA_ARGS__) + +namespace AKANTU_ITERATOR_NAMESPACE { + +template auto static_if(TPredicate) noexcept; + +namespace impl { + template struct static_if_impl; + + template struct static_if_result; + + template auto make_static_if_result(TF && f) noexcept; + + template <> struct static_if_impl { + template auto & else_(TF &&) noexcept { + // Ignore `else_`, as the predicate is true. + return *this; + } + + template auto & else_if(TPredicate) noexcept { + // Ignore `else_if`, as the predicate is true. + return *this; + } + + template auto then(TF && f) noexcept { + // We found a matching branch, just make a result and + // ignore everything else. + return make_static_if_result(FWD(f)); + } + }; + + template <> struct static_if_impl { + template auto & then(TF &&) noexcept { + // Ignore `then`, as the predicate is false. + return *this; + } + + template auto else_(TF && f) noexcept { + // (Assuming that `else_` is after all `else_if` calls.) + + // We found a matching branch, just make a result and + // ignore everything else. + + return make_static_if_result(FWD(f)); + } + + template auto else_if(TPredicate) noexcept { + return static_if(TPredicate{}); + } + + template auto operator()(Ts &&...) noexcept { + // If there are no `else` branches, we must ignore calls + // to a failed `static_if` matching. + } + }; + + template + struct static_if_result : TFunctionToCall { + // Perfect-forward the function in the result instance. + template + explicit static_if_result(TFFwd && f) noexcept : TFunctionToCall(FWD(f)) {} + + // Ignore everything, we found a result. + template auto & then(TF &&) noexcept { return *this; } + + template auto & else_if(TPredicate) noexcept { + return *this; + } + + template auto & else_(TF &&) noexcept { return *this; } + }; + + template auto make_static_if_result(TF && f) noexcept { + return static_if_result{FWD(f)}; + } +} // namespace impl + +template auto static_if(TPredicate) noexcept { + return impl::static_if_impl{}; +} + +#undef FWD +} // namespace AKANTU_ITERATOR_NAMESPACE + +#endif /* AKANTU_AKA_STATIC_IF_HH */ diff --git a/include/aka_tuple_tools.hh b/include/aka_tuple_tools.hh new file mode 100644 index 0000000..64feaef --- /dev/null +++ b/include/aka_tuple_tools.hh @@ -0,0 +1,126 @@ +/** + * @file aka_tuple_tools.hh + * + * @author Nicolas Richart + * + * @date creation: Fri Aug 11 2017 + * @date last modification: Mon Jan 29 2018 + * + * @brief iterator interfaces + * + * @section LICENSE + * + * Copyright 2019 EPFL (Ecole Polytechnique Fédérale de Lausanne) + * Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides) + * + * Akantu is free software: you can redistribute it and/or modify it under the + * terms of the GNU Lesser General Public License as published by the Free + * Software Foundation, either version 3 of the License, or (at your option) any + * later version. + * + * Akantu is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more + * details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Akantu. If not, see . + * + */ + +/* -------------------------------------------------------------------------- */ +#include +/* -------------------------------------------------------------------------- */ + +#ifndef AKANTU_AKA_TUPLE_TOOLS_HH +#define AKANTU_AKA_TUPLE_TOOLS_HH + +#ifndef AKANTU_ITERATOR_NAMESPACE +#define AKANTU_ITERATOR_NAMESPACE akantu +#endif + +namespace AKANTU_ITERATOR_NAMESPACE { + +namespace tuple { + /* ------------------------------------------------------------------------ */ + namespace details { + template struct Foreach { + template + static inline bool not_equal(Tuple && a, Tuple && b) { + if (std::get(std::forward(a)) == + std::get(std::forward(b))) + return false; + return Foreach::not_equal(std::forward(a), + std::forward(b)); + } + }; + + /* ---------------------------------------------------------------------- */ + template <> struct Foreach<0> { + template + static inline bool not_equal(Tuple && a, Tuple && b) { + return std::get<0>(std::forward(a)) != + std::get<0>(std::forward(b)); + } + }; + + template + decltype(auto) make_tuple_no_decay(Ts &&... args) { + return std::tuple(std::forward(args)...); + } + + template + void foreach_impl(F && func, Tuple && tuple, + std::index_sequence &&) { + (void)std::initializer_list{ + (std::forward(func)(std::get(std::forward(tuple))), + 0)...}; + } + + template + decltype(auto) transform_impl(F && func, Tuple && tuple, + std::index_sequence &&) { + return make_tuple_no_decay( + std::forward(func)(std::get(std::forward(tuple)))...); + } + } // namespace details + + /* ------------------------------------------------------------------------ */ + template bool are_not_equal(Tuple && a, Tuple && b) { + return details::Foreach>::value>:: + not_equal(std::forward(a), std::forward(b)); + } + + template void foreach (F && func, Tuple && tuple) { + return details::foreach_impl( + std::forward(func), std::forward(tuple), + std::make_index_sequence< + std::tuple_size>::value>{}); + } + + template + decltype(auto) transform(F && func, Tuple && tuple) { + return details::transform_impl( + std::forward(func), std::forward(tuple), + std::make_index_sequence< + std::tuple_size>::value>{}); + } + + namespace details { + template + decltype(auto) flatten(Tuple && tuples, std::index_sequence) { + return std::tuple_cat(std::get(tuples)...); + } + } // namespace details + + template decltype(auto) flatten(Tuple && tuples) { + return details::flatten(std::forward(tuples), + std::make_index_sequence< + std::tuple_size>::value>()); + } + +} // namespace tuple + +} // namespace AKANTU_ITERATOR_NAMESPACE + +#endif /* AKANTU_AKA_TUPLE_TOOLS_HH */ diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt new file mode 100644 index 0000000..58a3c59 --- /dev/null +++ b/test/CMakeLists.txt @@ -0,0 +1,8 @@ +enable_testing() + +add_executable(test_iterators test_iterators.cc) +target_link_libraries(test_iterators + PRIVATE akantu_iterators GTest::GTest) + +include(GoogleTest) +gtest_discover_tests(test_iterators) diff --git a/test/test_iterators.cc b/test/test_iterators.cc new file mode 100644 index 0000000..360e6e6 --- /dev/null +++ b/test/test_iterators.cc @@ -0,0 +1,387 @@ +/** + * @file test_zip_iterator.cc + * + * @author Nicolas Richart + * + * @date creation: Fri Jul 21 2017 + * @date last modification: Fri Dec 08 2017 + * + * @brief test the zip container and iterator + * + * @section LICENSE + * + * Copyright (©) 2016-2018 EPFL (Ecole Polytechnique Fédérale de Lausanne) + * Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides) + * + * Akantu is free software: you can redistribute it and/or modify it under the + * terms of the GNU Lesser General Public License as published by the Free + * Software Foundation, either version 3 of the License, or (at your option) any + * later version. + * + * Akantu is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more + * details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Akantu. If not, see . + * + */ + +/* -------------------------------------------------------------------------- */ +#include "aka_iterators.hh" +/* -------------------------------------------------------------------------- */ +#include +#include +/* -------------------------------------------------------------------------- */ + +using namespace akantu; + +/* -------------------------------------------------------------------------- */ + +// Non Trivial class that counts moves and copies +template class A { +public: + A() = default; + A(T a) : a(a){}; + A(const A & other) + : a(other.a), copy_counter(other.copy_counter + 1), + move_counter(other.move_counter) {} + A & operator=(const A & other) { + if (this != &other) { + a = other.a; + copy_counter = other.copy_counter + 1; + } + return *this; + } + + A(A && other) + : a(std::move(other.a)), copy_counter(std::move(other.copy_counter)), + move_counter(std::move(other.move_counter) + 1) {} + + A & operator=(A && other) { + if (this != &other) { + a = std::move(other.a); + copy_counter = std::move(other.copy_counter); + move_counter = std::move(other.move_counter) + 1; + } + return *this; + } + + A & operator*=(const T & b) { + a *= b; + return *this; + } + + T a; + size_t copy_counter{0}; + size_t move_counter{0}; +}; + +template struct C { + struct iterator { + using reference = A; + using difference_type = void; + using iterator_category = std::input_iterator_tag; + using value_type = A; + using pointer = A *; + + iterator(T pos) : pos(std::move(pos)) {} + + A operator*() { return A(pos); } + bool operator!=(const iterator & other) const { return pos != other.pos; } + bool operator==(const iterator & other) const { return pos == other.pos; } + iterator & operator++() { + ++pos; + return *this; + } + T pos; + }; + + C(T begin_, T end_) : begin_(std::move(begin_)), end_(std::move(end_)) {} + + iterator begin() { return iterator(begin_); } + iterator end() { return iterator(end_); } + + T begin_, end_; +}; + +class TestZipFixutre : public ::testing::Test { +protected: + void SetUp() override { + a.reserve(size); + b.reserve(size); + + for (size_t i = 0; i < size; ++i) { + a.emplace_back(i); + b.emplace_back(i + size); + } + } + + template + void check(A && a, B && b, size_t pos, size_t nb_copy, size_t nb_move) { + EXPECT_EQ(pos, a.a); + EXPECT_EQ(nb_copy, a.copy_counter); + EXPECT_EQ(nb_move, a.move_counter); + + EXPECT_FLOAT_EQ(pos + this->size, b.a); + EXPECT_EQ(nb_copy, b.copy_counter); + EXPECT_EQ(nb_move, b.move_counter); + } + +protected: + size_t size{20}; + std::vector> a; + std::vector> b; +}; + +TEST_F(TestZipFixutre, SimpleTest) { + size_t i = 0; + for (auto && pair : zip(this->a, this->b)) { + this->check(std::get<0>(pair), std::get<1>(pair), i, 0, 0); + ++i; + } +} + +TEST_F(TestZipFixutre, ConstTest) { + size_t i = 0; + const auto & ca = this->a; + const auto & cb = this->b; + for (auto && pair : zip(ca, cb)) { + this->check(std::get<0>(pair), std::get<1>(pair), i, 0, 0); + EXPECT_EQ(true, + std::is_const< + std::remove_reference_t(pair))>>::value); + EXPECT_EQ(true, + std::is_const< + std::remove_reference_t(pair))>>::value); + ++i; + } +} + +TEST_F(TestZipFixutre, MixteTest) { + size_t i = 0; + const auto & cb = this->b; + for (auto && pair : zip(a, cb)) { + this->check(std::get<0>(pair), std::get<1>(pair), i, 0, 0); + EXPECT_EQ(false, + std::is_const< + std::remove_reference_t(pair))>>::value); + EXPECT_EQ(true, + std::is_const< + std::remove_reference_t(pair))>>::value); + ++i; + } +} + +TEST_F(TestZipFixutre, MoveTest) { + size_t i = 0; + for (auto && pair : + zip(C(0, this->size), C(this->size, 2 * this->size))) { + this->check(std::get<0>(pair), std::get<1>(pair), i, 0, 1); + ++i; + } +} + +TEST_F(TestZipFixutre, Bidirectional) { + auto _zip = zip(a, b); + auto begin = _zip.begin(); + auto end = _zip.end(); + + auto it = begin; + ++it; + EXPECT_EQ(begin, --it); + + it = begin; + EXPECT_EQ(begin, it++); + EXPECT_EQ(begin, --it); + + auto it2 = it = begin; + ++it; ++it2; + EXPECT_EQ(it2, it--); + EXPECT_EQ(begin, it); +} + +TEST_F(TestZipFixutre, RandomAccess) { + auto _zip = zip(a, b); + auto begin = _zip.begin(); + auto end = _zip.end(); + + auto && val5 = begin[5]; + this->check(std::get<0>(val5), std::get<1>(val5), 5, 0, 0); + + auto && val13 = begin[13]; + this->check(std::get<0>(val13), std::get<1>(val13), 13, 0, 0); + + EXPECT_EQ(end - begin, a.size()); + auto it = ++begin; + EXPECT_EQ(begin + 1, ++it); + EXPECT_EQ(begin, it - 1); +} + +TEST_F(TestZipFixutre, Cat) { + size_t i = 0; + for (auto && data : make_zip_cat(zip(a, b), zip(a, b))) { + this->check(std::get<0>(data), std::get<1>(data), i, 0, 0); + this->check(std::get<2>(data), std::get<3>(data), i, 0, 0); + ++i; + } +} + +/* -------------------------------------------------------------------------- */ +TEST(TestArangeIterator, Stop) { + size_t ref_i = 0; + for (auto i : arange(10)) { + EXPECT_EQ(ref_i, i); + ++ref_i; + } +} + +TEST(TestArangeIterator, StartStop) { + size_t ref_i = 1; + for (auto i : arange(1, 10)) { + EXPECT_EQ(ref_i, i); + ++ref_i; + } +} + +TEST(TestArangeIterator, StartStopStep) { + size_t ref_i = 1; + for (auto i : arange(1, 22, 2)) { + EXPECT_EQ(ref_i, i); + ref_i += 2; + } +} + +TEST(TestArangeIterator, StartStopStepZipped) { + int ref_i1 = -1, ref_i2 = 1; + for (auto && i : zip(arange(-1, -10, -1), arange(1, 18, 2))) { + EXPECT_EQ(ref_i1, std::get<0>(i)); + EXPECT_EQ(ref_i2, std::get<1>(i)); + ref_i1 += -1; + ref_i2 += 2; + } +} + +/* -------------------------------------------------------------------------- */ +TEST(TestEnumerateIterator, SimpleTest) { + std::vector a {0, 10, 20, 30, 40}; + std::vector b {0, 2, 4, 6, 8}; + for (auto && data : enumerate(a, b)) { + EXPECT_EQ(std::get<0>(data) * 10, std::get<1>(data)); + EXPECT_EQ(std::get<0>(data) * 2, std::get<2>(data)); + } +} + + + +/* -------------------------------------------------------------------------- */ +TEST(TestTransformAdaptor, Keys) { + std::map map{ + {"1", 1}, {"2", 2}, {"3", 3}, {"3", 3}, {"4", 4}}; + + char counter = '1'; + for (auto && key : make_keys_adaptor(map)) { + EXPECT_EQ(counter, key[0]); + ++counter; + } +} + +TEST(TestTransformAdaptor, Values) { + std::map map{ + {"1", 1}, {"2", 2}, {"3", 3}, {"3", 3}, {"4", 4}}; + + int counter = 1; + for (auto && value : make_values_adaptor(map)) { + EXPECT_EQ(counter, value); + ++counter; + } +} + +static int plus1(int value) { return value + 1; } + +struct Plus { + Plus(int a) : a(a) {} + int operator()(int b) { return a + b; } + +private: + int a{0}; +}; + +TEST(TestTransformAdaptor, Lambda) { + auto && container = arange(10); + + for (auto && data : + zip(container, make_transform_adaptor(container, [](auto && value) { + return value + 1; + }))) { + EXPECT_EQ(std::get<0>(data) + 1, std::get<1>(data)); + } +} + +TEST(TestTransformAdaptor, LambdaLambda) { + std::map map{ + {"1", 1}, {"2", 2}, {"3", 3}, {"3", 3}, {"4", 4}}; + + int counter = 1; + for (auto && data : make_transform_adaptor( + make_values_adaptor(map), [](auto && value) { return value + 1; })) { + EXPECT_EQ(counter + 1, data); + ++counter; + } + + auto && container = arange(10); + + for (auto && data : + zip(container, make_transform_adaptor(container, [](auto && value) { + return value + 1; + }))) { + EXPECT_EQ(std::get<0>(data) + 1, std::get<1>(data)); + } +} + +TEST(TestTransformAdaptor, Function) { + auto && container = arange(10); + + for (auto && data : + zip(container, make_transform_adaptor(container, plus1))) { + EXPECT_EQ(std::get<0>(data) + 1, std::get<1>(data)); + } +} + +TEST(TestTransformAdaptor, Functor) { + auto && container = arange(10); + + for (auto && data : + zip(container, make_transform_adaptor(container, Plus(1)))) { + EXPECT_EQ(std::get<0>(data) + 1, std::get<1>(data)); + } +} + +/* -------------------------------------------------------------------------- */ +TEST(TestFilteredIterator, Simple) { + std::vector values{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10}; + std::vector filter{0, 2, 4, 10, 8, 6}; + for (auto && data : zip(filter, make_filtered_adaptor(filter, values))) { + EXPECT_EQ(std::get<0>(data), std::get<1>(data)); + } +} + +/* -------------------------------------------------------------------------- */ +TEST(TestFilteredIterator, Zip) { + std::vector a{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10}; + auto b = a; + std::vector filter{0, 2, 4, 10, 8, 6}; + for (auto && data : zip(filter, make_filtered_adaptor(filter, a, b))) { + EXPECT_EQ(std::get<0>(data), std::get<0>(std::get<1>(data))); + EXPECT_EQ(std::get<0>(data), std::get<1>(std::get<1>(data))); + } +} + + + +/* -------------------------------------------------------------------------- */ +int main(int argc, char **argv) { + ::testing::InitGoogleTest(&argc, argv); + return RUN_ALL_TESTS(); +}