From c2d73ef3c8604721fc9c4cc4d36b324486efdc6a Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Mon, 21 Jun 2021 21:06:42 +0000 Subject: [PATCH 01/13] (Yoshimi-test) Excerpt from the history https://github.com/Ichthyostega/yoshimi-test/ --- COPYING.md | 675 +++++++++++++++++++++++++++++++++++++++++++++++++++++ __README__ | 14 ++ 2 files changed, 689 insertions(+) create mode 100644 COPYING.md create mode 100644 __README__ diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 000000000..2fb2e74d8 --- /dev/null +++ b/COPYING.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/__README__ b/__README__ new file mode 100644 index 000000000..de3670076 --- /dev/null +++ b/__README__ @@ -0,0 +1,14 @@ +# Excerpt of statistics utilities from Yoshimi-test + +[Yoshimi](http://yoshimi.sourceforge.net/) is a software sound synthesizer, derived from ZynAddSubFx +and developed by an OpenSource community. The Repository [Yoshimi-test](https://github.com/Ichthyostega/yoshimi-test/) +is used by the Yoshimi developers to maintain a suite of automated acceptance tests for the Yoshimi application. + +This task involves watching execution times to detect long-term performance trends, +which in turn requires to maintain time-series data and perfrom some simple statistic calculations. +Requiring any external statistics package as dependency was not deemed adequate for such a simple task, +and thus a set of very limited self-contained helper functions was created as a byproduct. + + +2024-03-10: This is a filtered Git-history featuring only those helper functions + From a5238614286e69399b3893cf67d95c372888372c Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Thu, 26 Aug 2021 23:50:12 +0200 Subject: [PATCH 02/13] completed foundations of the testrunner - build the parametrisation from several config sources - read and interpret the test specifications in a subdirectory structure - as a result build a complete test suite definition as a sequence of test steps - setup a stage, also based on the parametrisation - actually perform the test suite and capture results - generate a test report --- yoshimi-testrunner/src/util/error.hpp | 114 +++++++++++++ yoshimi-testrunner/src/util/file.hpp | 75 +++++++++ yoshimi-testrunner/src/util/format.hpp | 81 ++++++++++ yoshimi-testrunner/src/util/regex.hpp | 61 +++++++ yoshimi-testrunner/src/util/utils.cpp | 68 ++++++++ yoshimi-testrunner/src/util/utils.hpp | 216 +++++++++++++++++++++++++ 6 files changed, 615 insertions(+) create mode 100644 yoshimi-testrunner/src/util/error.hpp create mode 100644 yoshimi-testrunner/src/util/file.hpp create mode 100644 yoshimi-testrunner/src/util/format.hpp create mode 100644 yoshimi-testrunner/src/util/regex.hpp create mode 100644 yoshimi-testrunner/src/util/utils.cpp create mode 100644 yoshimi-testrunner/src/util/utils.hpp diff --git a/yoshimi-testrunner/src/util/error.hpp b/yoshimi-testrunner/src/util/error.hpp new file mode 100644 index 000000000..42c456b1a --- /dev/null +++ b/yoshimi-testrunner/src/util/error.hpp @@ -0,0 +1,114 @@ +/* + * error - exceptions and error handling helpers + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file error.hpp + ** Definition of semantic exception classes and helpers for error handling. + ** - error::LogicBroken : violation of the application's internal logic assumptions. + ** Typically raising this exception implies a programming error. + ** - error::Misconfig : settings in configuration files or commandline miss expectations. + ** - error::ToDo : marker for "Stubs" or planned functionality during development. + ** - error::State : unexpected state or failure in system call. + ** + ** \par Shortcuts and Helpers + ** - Macro \ref UNIMPLEMENTED : shortcut for raising a error::ToDo + ** + ** @todo WIP as of 7/21 + ** + */ + + + +#ifndef TESTRUNNER_UTIL_ERROR_HPP_ +#define TESTRUNNER_UTIL_ERROR_HPP_ + + +#include +#include + +using std::string; + + + +namespace error { + +using std::logic_error; + + +class LogicBroken : public logic_error +{ +public: + LogicBroken(string msg) + : logic_error{"LogicBroken: " + msg} + { } +}; + + +class Misconfig : public logic_error +{ +public: + Misconfig(string msg) + : logic_error{"Misconfig: "+msg} + { } +}; + + +class Invalid : public logic_error +{ +public: + Invalid(string msg) + : logic_error{"Invalid Data: "+msg} + { } +}; + + +class State : public logic_error +{ +public: + State(string msg) + : logic_error{"Unforeseen state: "+msg} + { } +}; + + +class FailedLaunch : public State +{ +public: + FailedLaunch(string msg) + : State{"Launch of Test Case failed -- "+msg} + { } +}; + + +class ToDo : public logic_error +{ +public: + ToDo(string msg) : + logic_error{"UNIMPLEMENTED: "+msg} + { } +}; + + +} // namespace error + + +#define UNIMPLEMENTED(_MSG_) \ + throw error::ToDo(_MSG_) + +#endif /*TESTRUNNER_UTIL_ERROR_HPP_*/ diff --git a/yoshimi-testrunner/src/util/file.hpp b/yoshimi-testrunner/src/util/file.hpp new file mode 100644 index 000000000..2d4a0a84b --- /dev/null +++ b/yoshimi-testrunner/src/util/file.hpp @@ -0,0 +1,75 @@ +/* + * file - filesystem access and helpers + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file file.hpp + ** Includes the C++ Filesystem library and provides some convenience helpers. + ** The `std::filesystem` library allows for portable access to file and directory handling + ** functions; this header maps these functions with a convenient `fs::` namespace prefix, + ** and offers some convenience extensions, which are _"slightly non-portable"_ (they were + ** developed on Linux and "should" work on Unix like systems; adapters for exotic operating + ** systems could be added here when necessary...) + ** + */ + + + +#ifndef TESTRUNNER_UTIL_FILE_HPP_ +#define TESTRUNNER_UTIL_FILE_HPP_ + + +#include "util/error.hpp" + +#include +#include + + +namespace fs = std::filesystem; +namespace std::filesystem { + +const string UNIX_HOMEDIR_SYMBOL = "~"; +const char * const UNIX_HOMEDIR_ENV = "HOME"; + + +inline fs::path getHomePath() +{ + auto home = std::getenv(UNIX_HOMEDIR_ENV); + if (not home) + throw error::Misconfig("Program environment doesn't define $HOME (Unix home directory)."); + return fs::path{home}; +} + + +/** resolves symlinks, `~` (Unix home dir) and relative specs + * @return absolute canonical form if the path exists; + * otherwise only the home directory is expanded */ +inline fs::path consolidated(fs::path rawPath) +{ + if (rawPath.empty()) + return rawPath; + if (UNIX_HOMEDIR_SYMBOL == *rawPath.begin()) + rawPath = getHomePath() / rawPath.lexically_proximate(UNIX_HOMEDIR_SYMBOL); + + return fs::exists(rawPath)? fs::absolute( + fs::canonical(rawPath)) + : rawPath; +} + +}//(End)namespace fs +#endif /*TESTRUNNER_UTIL_TEE_HPP_*/ diff --git a/yoshimi-testrunner/src/util/format.hpp b/yoshimi-testrunner/src/util/format.hpp new file mode 100644 index 000000000..5ecfe20d9 --- /dev/null +++ b/yoshimi-testrunner/src/util/format.hpp @@ -0,0 +1,81 @@ +/* + * format - collection of test formatting helpers + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file format.hpp + ** Collection of helper functions for text and number output and formatting. + ** @todo WIP as of 7/21 + ** + */ + + + +#ifndef TESTRUNNER_UTIL_FORMAT_HPP_ +#define TESTRUNNER_UTIL_FORMAT_HPP_ + + +//#include +#include +#include + +using std::string; + + + +namespace util +{ + + +/** format number as string */ +template +inline string str(NUM n) +{ + std::ostringstream oss; + oss << n; + return oss.str(); +} + + +template +inline string formatVal(X x) +{ + return str(x); +} + +inline string formatVal(string s) +{ + return "\""+s+"\""; +} + +inline string formatVal(bool yes) +{ + return yes? "true":"false"; +} + +inline string formatVal(float f) +{ + std::ostringstream oss; + oss.precision(3); + oss.width(5); + oss << f; + return oss.str(); +} + +}//namespace util +#endif /*TESTRUNNER_UTIL_FORMAT_HPP_*/ diff --git a/yoshimi-testrunner/src/util/regex.hpp b/yoshimi-testrunner/src/util/regex.hpp new file mode 100644 index 000000000..ae398f4fa --- /dev/null +++ b/yoshimi-testrunner/src/util/regex.hpp @@ -0,0 +1,61 @@ +/* + * regex - helpers for working with regular expressions + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file regex.hpp + ** Convenience wrappers and helpers for dealing with regular expressions. + ** @see suite::step::ExeLauncher::ExeLauncher + ** + */ + + + +#ifndef TESTRUNNER_UTIL_PARSE_HPP_ +#define TESTRUNNER_UTIL_PARSE_HPP_ + + +#include +#include + +namespace util { + +using std::string; + + + +/** wrapped regex iterator to allow usage in foreach loops */ +struct MatchSeq + : std::sregex_iterator +{ + MatchSeq(string const& toParse, std::regex const& regex) + : std::sregex_iterator{toParse.begin(), toParse.end(), regex} + { } + + using iterator = std::sregex_iterator; + iterator begin() { return *this; } + iterator end() { return iterator(); } +}; + +/** + */ +MatchSeq allMatches(std::regex regex); + + +}//(End)namespace util +#endif /*TESTRUNNER_UTIL_PARSE_HPP_*/ diff --git a/yoshimi-testrunner/src/util/utils.cpp b/yoshimi-testrunner/src/util/utils.cpp new file mode 100644 index 000000000..29441d3ab --- /dev/null +++ b/yoshimi-testrunner/src/util/utils.cpp @@ -0,0 +1,68 @@ +/* + * utils - collection of general purpose helpers and tools + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file utils.cpp + ** Implementation details for some of the generic utils. + ** + ** @todo WIP as of 7/21 + ** + */ + + +#include "util/utils.hpp" +#include "util/error.hpp" + +#include + +using std::regex; + +namespace util { + +namespace { + const regex TRUE_TOKENS { "\\s*(true|yes|on|1|\\+)\\s*", regex::icase | regex::optimize }; + const regex FALSE_TOKENS{ "\\s*(false|no|off|0|\\-)\\s*", regex::icase | regex::optimize }; + + const regex TRIMMER{"\\s*(.*?)\\s*"}; +} + +bool boolVal(string const& textForm) +{ + if (regex_match(textForm, TRUE_TOKENS)) + return true; + if (regex_match(textForm, FALSE_TOKENS)) + return false; + throw error::Invalid{"String '"+textForm+"' can not be interpreted as bool value" }; +} + +bool isYes (string const& textForm) noexcept +{ + return regex_match (textForm, TRUE_TOKENS); +} + + +string trimmed(string text) +{ + std::smatch mat; + regex_match(text, mat, TRIMMER); + return mat[1]; +} + + +}//(End)namespace util diff --git a/yoshimi-testrunner/src/util/utils.hpp b/yoshimi-testrunner/src/util/utils.hpp new file mode 100644 index 000000000..5b0d44fed --- /dev/null +++ b/yoshimi-testrunner/src/util/utils.hpp @@ -0,0 +1,216 @@ +/* + * utils - collection of general purpose helpers and tools + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file utils.hpp + ** Collection of helper functions and abbreviations used to simplify code. + ** - \ref isnil(arg) checks if the argument is "empty"; argument can be a string or a container + ** - some helper functions for working with strings (`startsWith`, `endsWith`, `removePrefix|Suffix`) + ** - \ref trim(string) extracts the content without leading and trailing whitespace + ** - \ref boolVal() and \ref isYes() interpret a string as boolean value + ** - \ref contains() generic containment check for maps, strings and iterable containers + ** - Macro \ref STRINGIFY + ** @todo WIP as of 7/21 + ** + */ + + + +#ifndef TESTRUNNER_UTIL_UTILS_HPP_ +#define TESTRUNNER_UTIL_UTILS_HPP_ + + +#include +#include +#include + +using std::string; + +using uint = unsigned int; + + +namespace util { + +/* ======== generic empty check ========= */ + +/** a family of util functions providing a "no value whatsoever" test. + * Works on strings and all STL containers, includes NULL test for pointers + */ +template +inline bool isnil(const CONT &container) +{ + return container.empty(); +} + +template +inline bool isnil(const CONT *pContainer) +{ + return !pContainer or pContainer->empty(); +} + +template +inline bool isnil(CONT *pContainer) +{ + return !pContainer or pContainer->empty(); +} + +inline bool isnil(const char *pCStr) +{ + return !pCStr or !(*pCStr); +} + +/** check if string starts with a given prefix */ +inline bool startsWith(string const &str, string const &prefix) +{ + return 0 == str.rfind(prefix, 0); +} + +inline bool startsWith(string const &str, const char *prefix) +{ + return 0 == str.rfind(prefix, 0); +} + +/** check if string ends with the given suffix */ +inline bool endsWith(string const &str, string const &suffix) +{ + size_t l = suffix.length(); + if (l > str.length()) + return false; + size_t pos = str.length() - l; + return pos == str.find(suffix, pos); +} + +inline bool endsWith(string const &str, const char *suffix) +{ + return endsWith(str, string(suffix)); +} + +inline void removePrefix(string &str, string const &prefix) +{ + if (not startsWith(str, prefix)) + return; + str = str.substr(prefix.length()); +} + +inline void removeSuffix(string &str, string const &suffix) +{ + if (not endsWith(str, suffix)) + return; + str.resize(str.length() - suffix.length()); +} + +inline string replace(string src, string toFind, string replacement) +{ + for (size_t pos = src.find(toFind, 0); + pos != string::npos && toFind.size(); + pos = src.find(toFind, pos+replacement.size()) + ) + src.replace(pos, toFind.size(), replacement); + return src; +} + + +/** shortcut for containment test on a map */ +template +inline bool contains(MAP &map, typename MAP::key_type const &key) +{ + return map.find(key) != map.end(); +} + +/** shortcut for set value containment test */ +template +inline bool contains(std::set const &set, T const &val) +{ + return set.end() != set.find(val); +} + +/** shortcut for string value containment test */ +template +inline bool contains(std::string const &str, const T &val) +{ + return str.find(val) != std::string::npos; +} + +/** shortcut for brute-force containment test + * in any sequential container */ +template +inline bool contains(SEQ const &cont, typename SEQ::const_reference val) +{ + typename SEQ::const_iterator begin = cont.begin(); + typename SEQ::const_iterator end = cont.end(); + + return end != std::find(begin, end, val); +} + + +/** @internal helper type for #backwards */ +template +struct ReverseIterationAdapter { ITA& iterable; }; + +template +auto begin (ReverseIterationAdapter adapt) +{ + return std::rbegin(adapt.iterable); +} + +template +auto end (ReverseIterationAdapter adapt) +{ + return std::rend(adapt.iterable); +} + +/** + * Adapter to iterate backwards in a "foreach" loop. + * @tparam ITA a STL compatible container with back iteration capability. + * @remark solution based on the [Stackoverflow] from 2015 by [Prikso NAI]. + * + * [Stackoverflow]: https://stackoverflow.com/a/28139075 + * [Prikso NAI]: https://stackoverflow.com/users/3970469/prikso-nai + */ +template +inline ReverseIterationAdapter +backwards (ITA&& iterable) +{ + return { iterable }; +} + + +/** @return content without leading or trailing whitespace */ +string trimmed(string); + +/** interpret the given text as boolean value + * @throws error::Invalid when the text is not any valid bool token + * @remark allowed are `true false yes no on off 1 0 + -` in upper and lower case + */ +bool boolVal(string const& textForm); + +/** evaluate the given text form as boolean value for `true` + * @note other than (\ref boolVal), this function treats _everything else_ as `false` + */ +bool isYes (string const& textForm) noexcept; + +} // namespace util + + +/** this macro wraps its parameter into a cstring literal */ +#define STRINGIFY(TOKEN) __STRNGFY(TOKEN) +#define __STRNGFY(TOKEN) #TOKEN + + +#endif /*TESTRUNNER_UTIL_UTILS_HPP_*/ From b6a2eec94c70f603eab8e8c9fa35fc83b0a608c3 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Thu, 16 Sep 2021 23:54:11 +0200 Subject: [PATCH 03/13] parse a simplified variant of CSV rationale: the purpose is to read back our own values, yet it should be reasonably standard, to allow investigating and tweaking values with a spreadsheet - first line is a header line and used to verify the number of columns - one record per line, embedded line breaks prohibited - fields separated by comma, semicolon tolerated - fields are trimmed and may be empty - a field may be double quoted - only quoted fields may contain whitespace or comma - no escaping of quotes, i.e. no quotes within quotes --- yoshimi-testrunner/src/util/csv.hpp | 186 ++++++++++++++++++++++++++ yoshimi-testrunner/src/util/data.hpp | 173 ++++++++++++++++++++++++ yoshimi-testrunner/src/util/regex.hpp | 4 - 3 files changed, 359 insertions(+), 4 deletions(-) create mode 100644 yoshimi-testrunner/src/util/csv.hpp create mode 100644 yoshimi-testrunner/src/util/data.hpp diff --git a/yoshimi-testrunner/src/util/csv.hpp b/yoshimi-testrunner/src/util/csv.hpp new file mode 100644 index 000000000..50ecf1cdc --- /dev/null +++ b/yoshimi-testrunner/src/util/csv.hpp @@ -0,0 +1,186 @@ +/* + * csv - parser and encoder + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file csv.hpp + ** Encoding and decoding of data into CSV format. + ** The sequence of values transformed here is part of a data table, with columns + ** holding data of various primitive value types; persisted CSV data is human readable, + ** can be checked into Git and loaded into various spreadsheet and statistics applications. + ** + ** # CSV Format + ** Even while there is a standard defined in [RFC 4180], a plethora of format variations + ** can be found _in the wild._ Since the primary purpose of this implementation is _to read + ** back our own data,_ by deliberate choice only one single form of CSV is accepted. + ** - first line is a header line and used to verify the number of columns + ** - one record per line, embedded line breaks prohibited + ** - fields separated by comma, semicolon tolerated + ** - fields are trimmed and may be empty + ** - a field may be double quoted + ** - only quoted fields may contain whitespace or comma + ** - no escaping of quotes, i.e. no quotes within quotes + ** [RFC 4180]: https://datatracker.ietf.org/doc/html/rfc4180 + ** + ** @todo WIP as of 9/21 + ** @see util::DataFile used for [Timing statistics](\ref TimingObservation.hpp) + ** + */ + + + +#ifndef TESTRUNNER_UTIL_CSV_HPP_ +#define TESTRUNNER_UTIL_CSV_HPP_ + + +//#include "util/nocopy.hpp" +#include "util/error.hpp" +#include "util/format.hpp" +#include "util/regex.hpp" +//#include "util/utils.hpp" + +//#include +//#include +//#include +//#include + + +namespace util { + +using std::regex; +//using std::vector; +//using util::isnil; + +namespace { // Implementation details... + + const string MATCH_SINGLE_TOKEN {R"~(([^,;"\s]*)\s*)~"}; + const string MATCH_QUOTED_TOKEN {R"~("([^"]*)"\s*)~"}; + const string MATCH_DELIMITER {R"~((?:^|,|;)\s*)~"}; + + const regex ACCEPT_FIELD{ MATCH_DELIMITER + "(?:"+ MATCH_QUOTED_TOKEN +"|"+ MATCH_SINGLE_TOKEN +")" + , regex::optimize}; + + + template + inline string format4Csv(VAL const& val) + { + return util::str(val); + } + inline string format4Csv(string const& val) + { + return '"'+val+'"'; + } + +}//(End)Implementation + + +/** + * Parser to split one line of CSV data into fields. + * @remarks iterator-like throw-away object + * - the `bool` evaluation indicates more fields to extract + * - dereference to get the field as string + * - increment to move to the next field + * @throws error::Invalid on CSV format violation + */ +class CsvLine + : util::NonCopyable + , MatchSeq +{ + string const& line_; + size_t field_; + iterator curr_; + size_t pos_; + +public: + CsvLine(string const& line) + : MatchSeq(line, ACCEPT_FIELD) + , line_{line} + , field_{0} + , curr_{MatchSeq::begin()} + , pos_{0} + { } + + explicit operator bool() + { + return isValid(); + } + + string operator*() + { + if (not isValid()) fail(); + auto& mat = *curr_; + return mat[2].matched? mat[2] + : mat[1]; + } + + void operator++() + { + if (not isValid()) + fail(); + pos_ = curr_->position() + curr_->length(); + ++curr_; + if (pos_ < line_.length() and not isValid()) + fail(); + ++field_; + } + + size_t getParsedFieldCnt() + { + return field_; + } + + bool isValid() + { + return curr_ != end() + and curr_->position() == pos_ + and not curr_->empty(); + } + + void fail() + { + if (curr_ == end()) + if (pos_ >= line_.length()) + throw error::Invalid("Only "+formatVal(field_)+" data fields. Line:"+line_); + else + throw error::Invalid("Garbage after last field. Line:" + +line_.substr(0,pos_)+"|↯|"+line_.substr(pos_)); + else + if (pos_ != curr_->position()) + throw error::Invalid("Garbage before field("+formatVal(field_+1)+"):" + +line_.substr(0,pos_)+"|↯|"+line_.substr(pos_)); + else + throw error::Invalid("CSV parse floundered. Line:"+line_); + } +}; + + + +/** + * Format and append a data value to a CSV string representation + */ +template +inline void appendCsvField(string& csv, VAL const& val) +{ + csv += (0 == csv.length()? "":",") + + format4Csv(val); +} + + + +} // namespace util +#endif /*TESTRUNNER_UTIL_CSV_HPP_*/ diff --git a/yoshimi-testrunner/src/util/data.hpp b/yoshimi-testrunner/src/util/data.hpp new file mode 100644 index 000000000..426d07e95 --- /dev/null +++ b/yoshimi-testrunner/src/util/data.hpp @@ -0,0 +1,173 @@ +/* + * data - read and write a table with CSV data + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file data.hpp + ** Manage a table with time sequence data, stored persistently as CSV. + ** The Yoshimi Testsuite captures timing data, to detect the possible performance + ** impact of code reworking. Due to the statistical nature of timing measurements + ** and the dependency on the run environment, it is not sufficient just to rely on + ** a single measurement to establish the runtime characteristics of a given test; + ** rather, the statistical trend of the timings observed over several consecutive + ** runs of the Testsuite must be established. Short of using a database, a modest + ** amount of numeric data can be maintained in CSV files, which also allows for + ** further manual evaluation within a spreadsheet or statistics application. + ** + ** As a fundamental building block, this header provides a data table template + ** with a flexible column configuration to hold arbitrary, explicitly typed values. + ** This solution is statically typed and does not carry any runtime type information; + ** the actual data table object is then defined and accessed by means of _accessor_ + ** components for each column of data. A tuple of _current values_ corresponding to + ** the most recent row of data can be accessed directly through these sub-components. + ** + ** @todo WIP as of 9/21 + ** @see TimingObservation.hpp usage + ** + */ + + + +#ifndef TESTRUNNER_UTIL_DATA_HPP_ +#define TESTRUNNER_UTIL_DATA_HPP_ + + +#include "util/nocopy.hpp" +#include "util/error.hpp" +#include "util/utils.hpp" +#include "util/csv.hpp" + +//#include +//#include +#include +#include +#include + + +namespace util { + +using std::tuple; +using std::vector; +using util::isnil; + + + +/** + * perform some arbitrary operation on each element of a tuple. + * @note the given functor must be generic, since each position of the tuple + * may hold a data element of a different type. + * @remark credits to David Vandevoorde (member of C++ committee) for using + * std::apply to unpack the tuple's contents into an argument pack and + * then using a fold expression with the comma operator. + */ +template +void forEach(tuple&& tuple, FUN fun) +{ + std::apply([&fun](auto&... elms) + { + (fun(elms), ...); + } + ,tuple); +} + + +template +struct Column : util::NonCopyable +{ + string header; + vector data; + + + Column(string headerID) + : header{headerID} + , data{} + { } + + VAL& get() + { + if (isnil(data)) + throw error::State("No rows in DataTable yet"); + return data.back(); + } + + operator VAL&() + { + return get(); + } + + template + VAL& operator=(X&& newVal) + { + return get() = std::forward(newVal); + } +}; + + + +template +class DataFile + : public TAB + , util::NonCopyable +{ + +public: + DataFile() + { + newRow(); + } + + void newRow() + { + forEach(TAB::allColumns(), + [](auto& col) + { + col.data.resize(col.data.size()+1); + }); + } + + void reserve(size_t expectedCapacity) + { + forEach(TAB::allColumns(), + [=](auto& col) + { + col.data.reserve(expectedCapacity); + }); + } + + template + decltype(auto) getCol() + { + return std::get(TAB::allColumns()); + } + + template + decltype(auto) getStorage() + { + return getCol().data; + } + template + string getHeader() + { + return getCol().header; + } +}; + + + +} // namespace util +#endif /*TESTRUNNER_UTIL_DATA_HPP_*/ diff --git a/yoshimi-testrunner/src/util/regex.hpp b/yoshimi-testrunner/src/util/regex.hpp index ae398f4fa..f12ce28d9 100644 --- a/yoshimi-testrunner/src/util/regex.hpp +++ b/yoshimi-testrunner/src/util/regex.hpp @@ -52,10 +52,6 @@ struct MatchSeq iterator end() { return iterator(); } }; -/** - */ -MatchSeq allMatches(std::regex regex); - }//(End)namespace util #endif /*TESTRUNNER_UTIL_PARSE_HPP_*/ From a42de3ee1b432dd0e50b24524a07507e2dd12d55 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Fri, 17 Sep 2021 15:01:28 +0200 Subject: [PATCH 04/13] integrate CSV handling into the new data table type --- yoshimi-testrunner/src/util/csv.hpp | 6 +++ yoshimi-testrunner/src/util/data.hpp | 61 ++++++++++++++++++++++++++ yoshimi-testrunner/src/util/format.hpp | 21 ++++++++- yoshimi-testrunner/src/util/regex.hpp | 6 +-- yoshimi-testrunner/src/util/utils.hpp | 18 ++++++++ 5 files changed, 108 insertions(+), 4 deletions(-) diff --git a/yoshimi-testrunner/src/util/csv.hpp b/yoshimi-testrunner/src/util/csv.hpp index 50ecf1cdc..b0da3cca6 100644 --- a/yoshimi-testrunner/src/util/csv.hpp +++ b/yoshimi-testrunner/src/util/csv.hpp @@ -151,6 +151,12 @@ public: and not curr_->empty(); } + bool isParseFail() + { + return curr_ == end() + and not isValid(); + } + void fail() { if (curr_ == end()) diff --git a/yoshimi-testrunner/src/util/data.hpp b/yoshimi-testrunner/src/util/data.hpp index 426d07e95..d6264ccb5 100644 --- a/yoshimi-testrunner/src/util/data.hpp +++ b/yoshimi-testrunner/src/util/data.hpp @@ -54,8 +54,10 @@ //#include //#include +#include #include #include +#include #include @@ -92,6 +94,8 @@ struct Column : util::NonCopyable string header; vector data; + using ValueType = VAL; + Column(string headerID) : header{headerID} @@ -126,6 +130,8 @@ class DataFile { public: + static constexpr size_t columnCnt = std::tuple_size_v().allColumns())>; + DataFile() { newRow(); @@ -149,6 +155,61 @@ public: }); } + void appendRowFromCSV(string line) + { + newRow(); + CsvLine csv(line); + forEach(TAB::allColumns(), + [&](auto& col) + { + if (!csv) + if (csv.isParseFail()) + csv.fail(); + else + throw error::Invalid("Insufficient data; only " + +formatVal(csv.getParsedFieldCnt()) + +" fields. Line="+line); + + using Value = typename std::remove_reference::type::ValueType; + col.get() = parseAs(*csv); + ++csv; + }); + } + + string formatCSVRow(size_t rownum) + { + if (this->empty()) + throw error::LogicBroken("Attempt to access data from empty DataTable."); + if (rownum >= this->size()) + throw error::LogicBroken("Attempt to access row #"+str(rownum) + +" beyond range [0.."+str(size()-1)+"]."); + + string csvLine; + forEach(TAB::allColumns(), + [&](auto& col) + { + appendCsvField(csvLine, col.data.at(rownum)); + }); + return csvLine; + } + + size_t size() const + { + if (0 == columnCnt) return 0; + size_t rowCnt = std::numeric_limits::max(); + forEach(unConst(this)->allColumns(), + [&](auto& col) + { + rowCnt = std::min(rowCnt, col.data.size()); + }); + return rowCnt; + } + + bool empty() const + { + return 0 == this->size(); + } + template decltype(auto) getCol() { diff --git a/yoshimi-testrunner/src/util/format.hpp b/yoshimi-testrunner/src/util/format.hpp index 5ecfe20d9..44915ff5e 100644 --- a/yoshimi-testrunner/src/util/format.hpp +++ b/yoshimi-testrunner/src/util/format.hpp @@ -30,7 +30,8 @@ #define TESTRUNNER_UTIL_FORMAT_HPP_ -//#include +#include "util/utils.hpp" + #include #include @@ -77,5 +78,23 @@ inline string formatVal(float f) return oss.str(); } + +/** parse string representation into typed value */ +template +inline TAR parseAs(string const& encodedVal) +{ + std::istringstream converter{encodedVal}; + TAR value; + converter >> value; + return value; +} + +inline bool parseAs(string const& encodedBool) +{ + return util::boolVal(encodedBool); +} + + + }//namespace util #endif /*TESTRUNNER_UTIL_FORMAT_HPP_*/ diff --git a/yoshimi-testrunner/src/util/regex.hpp b/yoshimi-testrunner/src/util/regex.hpp index f12ce28d9..1aae85bc0 100644 --- a/yoshimi-testrunner/src/util/regex.hpp +++ b/yoshimi-testrunner/src/util/regex.hpp @@ -26,8 +26,8 @@ -#ifndef TESTRUNNER_UTIL_PARSE_HPP_ -#define TESTRUNNER_UTIL_PARSE_HPP_ +#ifndef TESTRUNNER_UTIL_REGEX_HPP_ +#define TESTRUNNER_UTIL_REGEX_HPP_ #include @@ -54,4 +54,4 @@ struct MatchSeq }//(End)namespace util -#endif /*TESTRUNNER_UTIL_PARSE_HPP_*/ +#endif /*TESTRUNNER_UTIL_REGEX_HPP_*/ diff --git a/yoshimi-testrunner/src/util/utils.hpp b/yoshimi-testrunner/src/util/utils.hpp index 5b0d44fed..3952e06fe 100644 --- a/yoshimi-testrunner/src/util/utils.hpp +++ b/yoshimi-testrunner/src/util/utils.hpp @@ -191,6 +191,24 @@ backwards (ITA&& iterable) } +/** + * Shortcut for casting away `const`. + * @warning Use with care. Can be very handy to simplify defining + * const and non-const variants of member functions though. + */ +template +inline OBJ* unConst (const OBJ* o) +{ +return const_cast (o); +} + +template +inline OBJ& unConst (OBJ const& ro) +{ +return const_cast (ro); +} + + /** @return content without leading or trailing whitespace */ string trimmed(string); From 7639ac41720baab2e8517feaf2e3b8bb9c8a8ad1 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Fri, 17 Sep 2021 17:57:55 +0200 Subject: [PATCH 05/13] complete implementation of CSV backed data table ...mostly routine after solving the tricky design challenge - for usage, instantiate the template DataFile with a Storage record - object is created with filename, and immediately slurps in existing data - data storage is optimised for readability (not speed); newest value at top Note: some kind of testcase is "hidden" in this changeset only; next changeset will remove research-experiment.hpp --- yoshimi-testrunner/src/util/csv.hpp | 2 +- yoshimi-testrunner/src/util/data.hpp | 265 ++++++++++++++++++++----- yoshimi-testrunner/src/util/file.hpp | 9 + yoshimi-testrunner/src/util/format.hpp | 3 + 4 files changed, 228 insertions(+), 51 deletions(-) diff --git a/yoshimi-testrunner/src/util/csv.hpp b/yoshimi-testrunner/src/util/csv.hpp index b0da3cca6..3bdd0e8c7 100644 --- a/yoshimi-testrunner/src/util/csv.hpp +++ b/yoshimi-testrunner/src/util/csv.hpp @@ -153,7 +153,7 @@ public: bool isParseFail() { - return curr_ == end() + return curr_ != end() and not isValid(); } diff --git a/yoshimi-testrunner/src/util/data.hpp b/yoshimi-testrunner/src/util/data.hpp index d6264ccb5..f109d0a03 100644 --- a/yoshimi-testrunner/src/util/data.hpp +++ b/yoshimi-testrunner/src/util/data.hpp @@ -19,7 +19,7 @@ /** @file data.hpp - ** Manage a table with time sequence data, stored persistently as CSV. + ** Manage a table with time series data, stored persistently as CSV. ** The Yoshimi Testsuite captures timing data, to detect the possible performance ** impact of code reworking. Due to the statistical nature of timing measurements ** and the dependency on the run environment, it is not sufficient just to rely on @@ -28,17 +28,42 @@ ** runs of the Testsuite must be established. Short of using a database, a modest ** amount of numeric data can be maintained in CSV files, which also allows for ** further manual evaluation within a spreadsheet or statistics application. - ** + ** ** As a fundamental building block, this header provides a data table template - ** with a flexible column configuration to hold arbitrary, explicitly typed values. + ** with flexible column configuration to hold arbitrary, explicitly typed values. ** This solution is statically typed and does not carry any runtime type information; ** the actual data table object is then defined and accessed by means of _accessor_ ** components for each column of data. A tuple of _current values_ corresponding to ** the most recent row of data can be accessed directly through these sub-components. - ** - ** @todo WIP as of 9/21 + ** + ** # Usage + ** Create an actual instantiation of the DataFile template, passing a structure + ** with util::Column descriptors. You may then directly access the values of the + ** _actual column_ or save/load from a persistent CSV file. + ** @note mandatory to define a method `allColumns()` + ** \code + ** struct Storage + ** { + ** Column name{"theName"}; + ** Column n{"counter"}; + ** Column x{"X value"}; + ** Column y{"Y value"}; + ** + ** auto allColumns(){ return std::tie(name,count,x,y); } + ** }; + ** + ** using Dataz = util::DataFile; + ** + ** Dataz daz("filename.csv"); + ** + ** daz.x = 123e-4; + ** daz.y = -12345e-6; + ** + ** std::vector& counters = daz.n.data; + ** \endcode + ** ** @see TimingObservation.hpp usage - ** + ** */ @@ -50,14 +75,16 @@ #include "util/nocopy.hpp" #include "util/error.hpp" #include "util/utils.hpp" +#include "util/file.hpp" #include "util/csv.hpp" -//#include -//#include #include #include +#include #include +#include #include +#include #include @@ -65,14 +92,15 @@ namespace util { using std::tuple; using std::vector; +using std::string; using util::isnil; /** - * perform some arbitrary operation on each element of a tuple. + * Helper: perform some arbitrary operation on each element of a tuple. * @note the given functor must be generic, since each position of the tuple - * may hold a data element of a different type. + * may hold a data element of different type. * @remark credits to David Vandevoorde (member of C++ committee) for using * std::apply to unpack the tuple's contents into an argument pack and * then using a fold expression with the comma operator. @@ -88,6 +116,12 @@ void forEach(tuple&& tuple, FUN fun) } + +/** + * Descriptor and Accessor for a data column within a DataFile table. + * @tparam VAL type of values contained within this column; + * this type must be _default constructible_ and _copyable._ + */ template struct Column : util::NonCopyable { @@ -102,6 +136,7 @@ struct Column : util::NonCopyable , data{} { } + VAL& get() { if (isnil(data)) @@ -123,20 +158,76 @@ struct Column : util::NonCopyable + + +/** + * Table with data values, stored persistently as CSV file. + * Each row within the table represents a data record, holding a sequence + * of values. Values are statically typed per column, i.e. one column may hold + * strings, while the next column holds doubles. For actual usage it is thus necessary + * to define the column layout, through a sequence of [column Descriptors](\ref util::Column). + * + * # Usage + * Actually those Column objects serve as descriptors, but also as accessors -- and they hold + * the actual data storage for each column, which is a `std::vector` of value type `VAL`. + * There is always a _current record_ -- corresponding to the actual data value and the newest + * data row. For persistent storage, the sequence of rows is _reversed,_ so the newest data + * appears at the top of the CSV file. + * @tparam TAB a struct comprised of several Column objects, which hold the data and + * provide access to values of this specific column. Moreover, this type _must define_ + * a function `allColumns()` to return a tuple with references to these column fields; + * the order of fields within this tuple also defines the order of columns + * within the table and persistent CSV storage. + * @see suite::step::TimingObservation (relevant usage example) + */ template class DataFile : public TAB , util::NonCopyable { + fs::path filename_; public: + DataFile(fs::path csvFile) + : filename_{consolidated(csvFile)} + { + loadData(); + } + + + /* === Data Access === */ + static constexpr size_t columnCnt = std::tuple_size_v().allColumns())>; - DataFile() + bool empty() const { - newRow(); + return 0 == this->size(); } + size_t size() const + { + if (0 == columnCnt) return 0; + size_t rowCnt = std::numeric_limits::max(); + forEach(unConst(this)->allColumns(), + [&](auto& col) + { + rowCnt = std::min(rowCnt, col.data.size()); + }); // the smallest number of data points found in any column + return rowCnt; + } + + string dumpCSV() const + { + string csv; + for (uint i=0; i < size(); ++i) + csv += formatCSVRow(i) + '\n'; + return csv; + } + + + + /* === Manipulation === */ + void newRow() { forEach(TAB::allColumns(), @@ -146,6 +237,18 @@ public: }); } + void dupRow() + { + if (empty()) + newRow(); + else + forEach(TAB::allColumns(), + [](auto& col) + { + col.data.emplace_back(col.data.back()); + }); + } + void reserve(size_t expectedCapacity) { forEach(TAB::allColumns(), @@ -155,6 +258,98 @@ public: }); } + + /** @param lineLimit number of rows to retain, back from the newest */ + void save(size_t lineLimit =std::numeric_limits::max()) + { + fs::path newFilename{filename_}; + newFilename += ".tmp"; + + std::ofstream csvFile{newFilename, std::ios_base::out | std::ios_base::trunc}; + if (not csvFile.good()) + throw error::State("Unable to create CSV output file "+formatVal(newFilename)); + saveData(csvFile, lineLimit); + + fs::path oldFile{filename_}; + oldFile += ".bak"; + if (fs::exists(filename_)) + fs::rename(filename_, oldFile); + fs::rename(newFilename, filename_); + } + + + +private: /* === Implementation === */ + + void loadData() + { + if (not (filename_.parent_path().empty() + or fs::exists(filename_.parent_path()))) + throw error::Invalid("DataFile("+formatVal(filename_.filename()) + +") shall be placed into nonexistent directory " + +formatVal(filename_.parent_path())); + if (not fs::exists(filename_)) + return; // leave the table empty + + std::ifstream csvFile(filename_); + if (not csvFile.good()) + throw error::Misconfig{"unable to read CSV data file "+formatVal(filename_)}; + + std::deque rawLines; + for (string line; std::getline(csvFile, line); ) + rawLines.emplace_back(move(line)); + + if (rawLines.size() < 1) return; + verifyHeaderSpec(rawLines[0]); + + // we know the number of rows now... + reserve(rawLines.size() - 1); + + // storage in file is backwards, with newest data on top + for (size_t row = rawLines.size()-1; 0 lineLimit? size()-lineLimit : 0; + // store newest data first, possibly discard old data + for (size_t row = size(); lineLimit < row; --row) + csvFile << formatCSVRow(row-1) << "\n"; + } + + + void verifyHeaderSpec(string headerLine) + { + CsvLine header(headerLine); + forEach(TAB::allColumns(), + [&](auto& col) + { + if (*header != col.header) + throw error::Invalid("Header mismatch in CSV file. " + "Expecting column("+formatVal(col.header) + +") but found "+formatVal(*header)); + ++header; + }); + } + + string generateHeaderSpec() + { + string csv; + forEach(TAB::allColumns(), + [&](auto& col) + { + appendCsvField(csv, col.header); + }); + return csv; + } + + void appendRowFromCSV(string line) { newRow(); @@ -167,16 +362,20 @@ public: csv.fail(); else throw error::Invalid("Insufficient data; only " - +formatVal(csv.getParsedFieldCnt()) - +" fields. Line="+line); + +str(csv.getParsedFieldCnt()) + +" fields, "+str(columnCnt) + +" expected. Line="+line); using Value = typename std::remove_reference::type::ValueType; col.get() = parseAs(*csv); ++csv; }); + if (csv) + throw error::Invalid("Excess data fields in CSV. Expect "+str(columnCnt)+" fields. Line="+line); } - string formatCSVRow(size_t rownum) + + string formatCSVRow(size_t rownum) const { if (this->empty()) throw error::LogicBroken("Attempt to access data from empty DataTable."); @@ -185,47 +384,13 @@ public: +" beyond range [0.."+str(size()-1)+"]."); string csvLine; - forEach(TAB::allColumns(), + forEach(unConst(this)->allColumns(), [&](auto& col) { appendCsvField(csvLine, col.data.at(rownum)); }); return csvLine; } - - size_t size() const - { - if (0 == columnCnt) return 0; - size_t rowCnt = std::numeric_limits::max(); - forEach(unConst(this)->allColumns(), - [&](auto& col) - { - rowCnt = std::min(rowCnt, col.data.size()); - }); - return rowCnt; - } - - bool empty() const - { - return 0 == this->size(); - } - - template - decltype(auto) getCol() - { - return std::get(TAB::allColumns()); - } - - template - decltype(auto) getStorage() - { - return getCol().data; - } - template - string getHeader() - { - return getCol().header; - } }; diff --git a/yoshimi-testrunner/src/util/file.hpp b/yoshimi-testrunner/src/util/file.hpp index 2d4a0a84b..89ed003e4 100644 --- a/yoshimi-testrunner/src/util/file.hpp +++ b/yoshimi-testrunner/src/util/file.hpp @@ -72,4 +72,13 @@ inline fs::path consolidated(fs::path rawPath) } }//(End)namespace fs + +namespace util { + +inline string formatVal(fs::path path) +{ + return "\""+string{path}+"\""; +} + +}//(End)namespace util #endif /*TESTRUNNER_UTIL_TEE_HPP_*/ diff --git a/yoshimi-testrunner/src/util/format.hpp b/yoshimi-testrunner/src/util/format.hpp index 44915ff5e..645ee5c01 100644 --- a/yoshimi-testrunner/src/util/format.hpp +++ b/yoshimi-testrunner/src/util/format.hpp @@ -86,9 +86,12 @@ inline TAR parseAs(string const& encodedVal) std::istringstream converter{encodedVal}; TAR value; converter >> value; + if (converter.fail()) + throw error::Invalid("unable to parse "+formatVal(encodedVal)); return value; } +template<> inline bool parseAs(string const& encodedBool) { return util::boolVal(encodedBool); From 75767a3a977a5c71adebaaeb40e09d4dae4fa843 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Sun, 19 Sep 2021 17:31:54 +0200 Subject: [PATCH 06/13] capture and store individual timings as time series Note: work-in-progress... TODO: derive the expense factor and delta --- yoshimi-testrunner/src/util/data.hpp | 2 +- yoshimi-testrunner/src/util/format.hpp | 5 ++ yoshimi-testrunner/src/util/statistic.cpp | 57 +++++++++++++++++++++++ yoshimi-testrunner/src/util/statistic.hpp | 56 ++++++++++++++++++++++ 4 files changed, 119 insertions(+), 1 deletion(-) create mode 100644 yoshimi-testrunner/src/util/statistic.cpp create mode 100644 yoshimi-testrunner/src/util/statistic.hpp diff --git a/yoshimi-testrunner/src/util/data.hpp b/yoshimi-testrunner/src/util/data.hpp index f109d0a03..dee0710c5 100644 --- a/yoshimi-testrunner/src/util/data.hpp +++ b/yoshimi-testrunner/src/util/data.hpp @@ -49,7 +49,7 @@ ** Column x{"X value"}; ** Column y{"Y value"}; ** - ** auto allColumns(){ return std::tie(name,count,x,y); } + ** auto allColumns(){ return std::tie(name,n,x,y); } ** }; ** ** using Dataz = util::DataFile; diff --git a/yoshimi-testrunner/src/util/format.hpp b/yoshimi-testrunner/src/util/format.hpp index 645ee5c01..82124aca0 100644 --- a/yoshimi-testrunner/src/util/format.hpp +++ b/yoshimi-testrunner/src/util/format.hpp @@ -96,6 +96,11 @@ inline bool parseAs(string const& encodedBool) { return util::boolVal(encodedBool); } +template<> +inline string parseAs(string const& string) +{ + return string; // pass-through (even if empty) +} diff --git a/yoshimi-testrunner/src/util/statistic.cpp b/yoshimi-testrunner/src/util/statistic.cpp new file mode 100644 index 000000000..22c3d21f0 --- /dev/null +++ b/yoshimi-testrunner/src/util/statistic.cpp @@ -0,0 +1,57 @@ +/* + * statistic - helpers for generic statistics calculations + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file statistic.cpp + ** Implementation details for generic statistics calculations. + ** + ** @todo WIP as of 9/21 + ** + */ + + +#include "util/statistic.hpp" +//#include "util/format.hpp" +#include "util/error.hpp" + +//#include +//#include +//#include + + +namespace util { + +//using util::formatVal; +//using std::log10; +//using std::fabs; +//using std::max; +//using std::min; + + +namespace { // Implementation details +}//(End)Implementation namespace + + + + +/** + */ + + +}//(End)namespace util diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp new file mode 100644 index 000000000..03d239a13 --- /dev/null +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -0,0 +1,56 @@ +/* + * statistic - helpers for generic statistics calculations + * + * Copyright 2021, Hermann Vosseler + * + * This file is part of the Yoshimi-Testsuite, which is free software: + * you can redistribute 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. + * + * Yoshimi-Testsuite 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 yoshimi. If not, see . + ***************************************************************/ + + +/** @file statistic.cpp + ** Support for generic statistics calculations. + ** + ** @todo WIP as of 9/21 + ** + */ + + + +#ifndef TESTRUNNER_UTIL_STATISTIC_HPP_ +#define TESTRUNNER_UTIL_STATISTIC_HPP_ + + +#include "util/error.hpp" + +//#include +//#include +#include +//#include + +namespace util { + +//using util::formatVal; +//using std::log10; +//using std::fabs; +//using std::max; +//using std::min; + +using VecD = std::vector; + +namespace { // Implementation details +}//(End)Implementation namespace + + +}//(End)namespace util +#endif /*TESTRUNNER_UTIL_STATISTIC_HPP_*/ From 015a6ed6f21e6a842751907f0022b5ab9715c66f Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Mon, 20 Sep 2021 02:26:01 +0200 Subject: [PATCH 07/13] add global storage and apply existing platform model ...this is largely just wiring of components built thus far ...TODO build platform model by linear regression --- yoshimi-testrunner/src/util/data.hpp | 6 +++++- yoshimi-testrunner/src/util/statistic.hpp | 11 +++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/yoshimi-testrunner/src/util/data.hpp b/yoshimi-testrunner/src/util/data.hpp index dee0710c5..1be4c3f8b 100644 --- a/yoshimi-testrunner/src/util/data.hpp +++ b/yoshimi-testrunner/src/util/data.hpp @@ -93,7 +93,6 @@ namespace util { using std::tuple; using std::vector; using std::string; -using util::isnil; @@ -149,6 +148,11 @@ struct Column : util::NonCopyable return get(); } + operator VAL const&() const + { + return unConst(this)->get(); + } + template VAL& operator=(X&& newVal) { diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp index 03d239a13..049bc3259 100644 --- a/yoshimi-testrunner/src/util/statistic.hpp +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -52,5 +52,16 @@ namespace { // Implementation details }//(End)Implementation namespace +inline double averageLastN(VecD const& data, size_t n) +{ + n = std::min(n, data.size()); + size_t oldest = data.size() - n; + double sum = 0.0; + for (size_t i=data.size(); oldest < i; --i) + sum += data[i-1]; + return 0 Date: Sat, 25 Sep 2021 03:39:21 +0200 Subject: [PATCH 08/13] implement fitting the platform model by linear regression * triggered by --calibrate * normalise away any known expense factors, but use them as weight * calculate simple linear regression from statistic data --- yoshimi-testrunner/src/util/csv.hpp | 20 ++--- yoshimi-testrunner/src/util/data.hpp | 17 +++-- yoshimi-testrunner/src/util/statistic.hpp | 89 ++++++++++++++++++++++- 3 files changed, 109 insertions(+), 17 deletions(-) diff --git a/yoshimi-testrunner/src/util/csv.hpp b/yoshimi-testrunner/src/util/csv.hpp index 3bdd0e8c7..63f683690 100644 --- a/yoshimi-testrunner/src/util/csv.hpp +++ b/yoshimi-testrunner/src/util/csv.hpp @@ -48,23 +48,18 @@ #define TESTRUNNER_UTIL_CSV_HPP_ -//#include "util/nocopy.hpp" #include "util/error.hpp" #include "util/format.hpp" #include "util/regex.hpp" -//#include "util/utils.hpp" -//#include -//#include -//#include -//#include +#include +#include namespace util { using std::regex; -//using std::vector; -//using util::isnil; +using std::string; namespace { // Implementation details... @@ -79,12 +74,19 @@ namespace { // Implementation details... template inline string format4Csv(VAL const& val) { - return util::str(val); + std::ostringstream oss; + oss.precision(std::numeric_limits::digits10); + oss << val; + return oss.str(); } inline string format4Csv(string const& val) { return '"'+val+'"'; } + inline string format4Csv(bool boo) + { + return formatVal(boo); + } }//(End)Implementation diff --git a/yoshimi-testrunner/src/util/data.hpp b/yoshimi-testrunner/src/util/data.hpp index 1be4c3f8b..f3e0b3e12 100644 --- a/yoshimi-testrunner/src/util/data.hpp +++ b/yoshimi-testrunner/src/util/data.hpp @@ -264,7 +264,7 @@ public: /** @param lineLimit number of rows to retain, back from the newest */ - void save(size_t lineLimit =std::numeric_limits::max()) + void save(size_t lineLimit =std::numeric_limits::max(), bool backupOld =false) { fs::path newFilename{filename_}; newFilename += ".tmp"; @@ -274,10 +274,13 @@ public: throw error::State("Unable to create CSV output file "+formatVal(newFilename)); saveData(csvFile, lineLimit); - fs::path oldFile{filename_}; - oldFile += ".bak"; - if (fs::exists(filename_)) - fs::rename(filename_, oldFile); + if (backupOld) + { + fs::path oldFile{filename_}; + oldFile += ".bak"; + if (fs::exists(filename_)) + fs::rename(filename_, oldFile); + } fs::rename(newFilename, filename_); } @@ -335,8 +338,8 @@ private: /* === Implementation === */ [&](auto& col) { if (*header != col.header) - throw error::Invalid("Header mismatch in CSV file. " - "Expecting column("+formatVal(col.header) + throw error::Invalid("Header mismatch in CSV file "+formatVal(filename_) + +". Expecting column("+formatVal(col.header) +") but found "+formatVal(*header)); ++header; }); diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp index 049bc3259..c71a3dfa2 100644 --- a/yoshimi-testrunner/src/util/statistic.hpp +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -36,7 +36,9 @@ //#include //#include #include -//#include +#include +#include +#include namespace util { @@ -63,5 +65,90 @@ inline double averageLastN(VecD const& data, size_t n) } +/** + * Single data point used for linear regression. + * Simple case: single predictor variable (x). + * @remark including a weight factor + */ +struct RegressionPoint +{ + double x; + double y; + double w; +}; + +using RegressionData = std::vector; + + +/** "building blocks" for weighted mean, weighted variance and covariance */ +inline auto computeWeightedStatSums(RegressionData const& points) +{ + std::array sums = {0.0,0.0,0.0,0.0,0.0,0.0}; + auto& [wsum, wxsum, wysum, wxxsum, wyysum, wxysum] = sums; + for (auto& p : points) + { + wsum += p.w; + wxsum += p.w * p.x; + wysum += p.w * p.y; + wxxsum += p.w * p.x*p.x; + wyysum += p.w * p.y*p.y; + wxysum += p.w * p.x*p.y; + } + return sums; +} + +/** + * Compute simple linear regression with a single predictor variable (x). + * @param points data to fit the linear model with + * @return the computed linear model `b + a·x`, and the resulting fit + * - socket (constant offset `b`) + * - gradient (linear factor `a`) + * - a vector with a predicted `y` value for each `x` value + * - a vector with the error, i.e `Δ = y - y_predicted` + * - correlation between x and y values + * - maximum absolute delta + * - delta standard deviation + */ +inline std::tuple computeLinearRegression(RegressionData const& points) +{ + auto [wsum, wxsum, wysum, wxxsum, wyysum, wxysum] = computeWeightedStatSums(points); + + double xm = wxsum / wsum; // weighted mean x = 1/Σw · Σwx + double ym = wysum / wsum; + double varx = wxxsum + xm*xm * wsum - 2*xm * wxsum; // Σw · x-Variance = Σw(x-xm)² + double vary = wyysum + ym*ym * wsum - 2*ym * wysum; + double cova = wxysum + xm*ym * wsum - ym * wxsum - xm * wysum; // Σw · Covariance = Σw(x-xm)(y-ym) + + // Linear Regression minimising σ² + double gradient = cova / varx; // gradient = correlation · σy / σx ; σ = √Variance + double socket = ym - gradient * xm; // Regression line: Y-ym = gradient · (x-xm) ; set x≔0 yields socket + + // Correlation (Pearson's r) + double correlation = gradient * sqrt(varx/vary); + + // calculate error Δ for all measurement points + VecD predicted; predicted.reserve(points.size()); + VecD deltas; deltas.reserve(points.size()); + double maxDelta = 0.0; + double variance = 0.0; + for (auto& p : points) + { + double y_pred = socket + gradient * p.x; + double delta = p.y - y_pred; + predicted.push_back(y_pred); + deltas.push_back(delta); + maxDelta = std::max(maxDelta, fabs(delta)); + variance += p.w * delta*delta; + } + return std::make_tuple(socket,gradient + ,move(predicted) + ,move(deltas) + ,correlation + ,maxDelta + ,sqrt(variance/wsum) + ); +} + + }//(End)namespace util #endif /*TESTRUNNER_UTIL_STATISTIC_HPP_*/ From e9eae205f07a969b9020e2ef1bb85b910803616e Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Sun, 3 Oct 2021 04:00:51 +0200 Subject: [PATCH 09/13] use regression to monitor short term and long term trends Since the platform calibration inevitably incurs some additional error band, a linear regresssion over the time series of measurements can additionally be used to spot ongoing systematic changes below this general error band, while leveling out local statistical fluctuations. --- yoshimi-testrunner/src/util/statistic.cpp | 57 ------- yoshimi-testrunner/src/util/statistic.hpp | 182 ++++++++++++++++++---- 2 files changed, 154 insertions(+), 85 deletions(-) delete mode 100644 yoshimi-testrunner/src/util/statistic.cpp diff --git a/yoshimi-testrunner/src/util/statistic.cpp b/yoshimi-testrunner/src/util/statistic.cpp deleted file mode 100644 index 22c3d21f0..000000000 --- a/yoshimi-testrunner/src/util/statistic.cpp +++ /dev/null @@ -1,57 +0,0 @@ -/* - * statistic - helpers for generic statistics calculations - * - * Copyright 2021, Hermann Vosseler - * - * This file is part of the Yoshimi-Testsuite, which is free software: - * you can redistribute 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. - * - * Yoshimi-Testsuite 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 yoshimi. If not, see . - ***************************************************************/ - - -/** @file statistic.cpp - ** Implementation details for generic statistics calculations. - ** - ** @todo WIP as of 9/21 - ** - */ - - -#include "util/statistic.hpp" -//#include "util/format.hpp" -#include "util/error.hpp" - -//#include -//#include -//#include - - -namespace util { - -//using util::formatVal; -//using std::log10; -//using std::fabs; -//using std::max; -//using std::min; - - -namespace { // Implementation details -}//(End)Implementation namespace - - - - -/** - */ - - -}//(End)namespace util diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp index c71a3dfa2..9fe37e6e2 100644 --- a/yoshimi-testrunner/src/util/statistic.hpp +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -20,9 +20,10 @@ /** @file statistic.cpp ** Support for generic statistics calculations. - ** - ** @todo WIP as of 9/21 - ** + ** - average over the N last elements in a data sequence + ** - simple linear regression with weights (single predictor variable) + ** - also over a time series with zero-based indices + ** */ @@ -32,9 +33,10 @@ #include "util/error.hpp" +#include "util/nocopy.hpp" +#include "util/format.hpp" +#include "util/utils.hpp" -//#include -//#include #include #include #include @@ -42,26 +44,110 @@ namespace util { -//using util::formatVal; -//using std::log10; -//using std::fabs; -//using std::max; -//using std::min; +using std::fabs; +using std::array; +using std::tuple; +using std::make_tuple; + + +/** + * Read-only view into a segment within a sequence of data + * @tparam D value type of the data series + * @remark simplistic workaround since we don't support C++20 yet + * @todo replace by const std::span + */ +template +class DataSpan + : util::Cloneable +{ + const D* const b_{nullptr}; + const D* const e_{nullptr}; + +public: + DataSpan() = default; + DataSpan(D const& begin, D const& end) + : b_{&begin} + , e_{&end} + { if (e_ < b_) throw error::Invalid("End point before begin."); } + + template + DataSpan(CON const& container) + : DataSpan{*std::begin(container), *std::end(container)} + { } + + + using iterator = const D*; + + size_t size() const { return e_ - b_; } + bool empty() const { return b_ == e_; } + + iterator begin() const { return b_; } + iterator end() const { return e_; } + + D const& operator[](size_t i) const { return b_ + i; } + D const& at(size_t i) const + { + if (i >= size()) throw error::Invalid("Index "+str(i)+" beyond size="+str(size())); + return this->operator[](i); + } +}; + + +template +using Span = DataSpan const&; using VecD = std::vector; -namespace { // Implementation details -}//(End)Implementation namespace +/** helper to unpack a std::tuple into a homogeneous std::array */ +template +constexpr auto array_from_tuple(TUP&& tuple) +{ + constexpr auto makeArray = [](auto&& ... x){ return std::array{std::forward(x) ... }; }; + return std::apply(makeArray, std::forward(tuple)); +} -inline double averageLastN(VecD const& data, size_t n) + +template +inline double average(Span data) +{ + if (isnil(data)) return 0.0; + double sum = 0.0; + for (auto val : data) + sum += val; + return sum / data.size(); +} + + +inline DataSpan lastN(VecD const& data, size_t n) { n = std::min(n, data.size()); size_t oldest = data.size() - n; - double sum = 0.0; - for (size_t i=data.size(); oldest < i; --i) - sum += data[i-1]; - return 0{data[oldest], *data.end()}; +} + +inline double averageLastN(VecD const& data, size_t n) +{ + return average(lastN(data,n)); +} + + +/** "building blocks" for mean, variance and covariance of time series data */ +template +inline auto computeStatSums(Span series) +{ + double ysum = 0.0; + double yysum = 0.0; + double xysum = 0.0; + size_t x = 0; + for (auto& y : series) + { + ysum += y; + yysum += y*y; + xysum += x*y; + ++x; + } + return make_tuple(ysum,yysum, xysum); } @@ -81,9 +167,10 @@ using RegressionData = std::vector; /** "building blocks" for weighted mean, weighted variance and covariance */ -inline auto computeWeightedStatSums(RegressionData const& points) +inline auto computeWeightedStatSums(Span points) { - std::array sums = {0.0,0.0,0.0,0.0,0.0,0.0}; + std::array sums; + sums.fill(0.0); auto& [wsum, wxsum, wysum, wxxsum, wyysum, wxysum] = sums; for (auto& p : points) { @@ -99,7 +186,7 @@ inline auto computeWeightedStatSums(RegressionData const& points) /** * Compute simple linear regression with a single predictor variable (x). - * @param points data to fit the linear model with + * @param points 2D data to fit the linear model with, including weights. * @return the computed linear model `b + a·x`, and the resulting fit * - socket (constant offset `b`) * - gradient (linear factor `a`) @@ -109,7 +196,7 @@ inline auto computeWeightedStatSums(RegressionData const& points) * - maximum absolute delta * - delta standard deviation */ -inline std::tuple computeLinearRegression(RegressionData const& points) +inline auto computeLinearRegression(Span points) { auto [wsum, wxsum, wysum, wxxsum, wyysum, wxysum] = computeWeightedStatSums(points); @@ -140,15 +227,54 @@ inline std::tuple computeLinearR maxDelta = std::max(maxDelta, fabs(delta)); variance += p.w * delta*delta; } - return std::make_tuple(socket,gradient - ,move(predicted) - ,move(deltas) - ,correlation - ,maxDelta - ,sqrt(variance/wsum) - ); + return make_tuple(socket,gradient + ,move(predicted) + ,move(deltas) + ,correlation + ,maxDelta + ,sqrt(variance/wsum) + ); } +inline auto computeLinearRegression(RegressionData const& points) +{ return computeLinearRegression(DataSpan{points}); } + + + +/** + * Compute linear regression over a time series with zero-based indices. + * @remark using the indices as x-values, the calculations for a regression line + * can be simplified, using the known closed formula for a sum of integers, + * shifting the indices to 0…n-1 (leaving out the 0 and 0² term) + * - `1+…+n = n·(n+1)/2` + * - `1+…+n² = n·(n+1)·(2n+1)/6` + * @return `(socket,gradient)` to describe the regression line y = socket + gradient · i + */ +template +inline auto computeTimeSeriesLinearRegression(Span series) +{ + auto [ysum,yysum, xysum] = computeStatSums(series); + + size_t n = series.size(); + double im = (n-1)/2.0; // mean of zero-based indices i ∈ {0 … n-1} + double ym = ysum / n; // mean y + double varx = (n-1)*(n+1)/12.0; // variance of zero-based indices Σ(i-im)² / n + double vary = yysum/n - ym*ym; // variance of data values Σ(y-ym)² / n + double cova = xysum - ysum *(n-1)/2; // Time series Covariance = Σ(i-im)(y-ym) = Σiy + im·ym·n - ym·Σi - im·Σy; use n*ym = Σy + + // Linear Regression minimising σ² + double gradient = cova / (n*varx); // Gradient = Correlation · σy / σx ; σ = √Variance; Correlation = Covariance /(√Σx √Σy) + double socket = ym - gradient * im; // Regression line: Y-ym = Gradient · (i-im) ; set i≔0 yields socket + + // Correlation (Pearson's r) + double correlation = gradient * sqrt(varx/vary); + return make_tuple(socket,gradient,correlation); +} + +inline auto computeTimeSeriesLinearRegression(VecD const& series) +{ return computeTimeSeriesLinearRegression(Span{series}); } + + }//(End)namespace util #endif /*TESTRUNNER_UTIL_STATISTIC_HPP_*/ From f2adfc6406158a71aac13889f750f9abee6c8336 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Mon, 4 Oct 2021 03:59:51 +0200 Subject: [PATCH 10/13] calculate statistics and trend for the complete testsuite --- yoshimi-testrunner/src/util/statistic.hpp | 68 ++++++++++++++++------- 1 file changed, 47 insertions(+), 21 deletions(-) diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp index 9fe37e6e2..d5768619c 100644 --- a/yoshimi-testrunner/src/util/statistic.hpp +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -49,6 +49,17 @@ using std::array; using std::tuple; using std::make_tuple; +using VecD = std::vector; + +/** helper to unpack a std::tuple into a homogeneous std::array */ +template +constexpr auto array_from_tuple(TUP&& tuple) +{ + constexpr auto makeArray = [](auto&& ... x){ return std::array{std::forward(x) ... }; }; + return std::apply(makeArray, std::forward(tuple)); +} + + /** @@ -94,22 +105,10 @@ public: }; -template -using Span = DataSpan const&; -using VecD = std::vector; - -/** helper to unpack a std::tuple into a homogeneous std::array */ -template -constexpr auto array_from_tuple(TUP&& tuple) -{ - constexpr auto makeArray = [](auto&& ... x){ return std::array{std::forward(x) ... }; }; - return std::apply(makeArray, std::forward(tuple)); -} - template -inline double average(Span data) +inline double average(DataSpan const& data) { if (isnil(data)) return 0.0; double sum = 0.0; @@ -118,6 +117,25 @@ inline double average(Span data) return sum / data.size(); } +template +inline double sdev(DataSpan const& data, D mean) +{ + if (isnil(data)) return 0.0; + double sdev = 0.0; + for (auto val : data) + { + D offset = val - mean; + sdev += offset*offset; + } + size_t n = data.size(); + sdev /= n<2? 1: n-1; + return sqrt(sdev); +} + +inline double sdev(VecD const& data, double mean) +{ return sdev(DataSpan{data}, mean); } + + inline DataSpan lastN(VecD const& data, size_t n) { @@ -131,10 +149,15 @@ inline double averageLastN(VecD const& data, size_t n) return average(lastN(data,n)); } +inline double sdevLastN(VecD const& data, double mean, size_t n) +{ + return sdev(lastN(data,n), mean); +} + /** "building blocks" for mean, variance and covariance of time series data */ template -inline auto computeStatSums(Span series) +inline auto computeStatSums(DataSpan const& series) { double ysum = 0.0; double yysum = 0.0; @@ -167,7 +190,7 @@ using RegressionData = std::vector; /** "building blocks" for weighted mean, weighted variance and covariance */ -inline auto computeWeightedStatSums(Span points) +inline auto computeWeightedStatSums(DataSpan const& points) { std::array sums; sums.fill(0.0); @@ -196,7 +219,7 @@ inline auto computeWeightedStatSums(Span points) * - maximum absolute delta * - delta standard deviation */ -inline auto computeLinearRegression(Span points) +inline auto computeLinearRegression(DataSpan const& points) { auto [wsum, wxsum, wysum, wxxsum, wyysum, wxysum] = computeWeightedStatSums(points); @@ -214,8 +237,9 @@ inline auto computeLinearRegression(Span points) double correlation = gradient * sqrt(varx/vary); // calculate error Δ for all measurement points - VecD predicted; predicted.reserve(points.size()); - VecD deltas; deltas.reserve(points.size()); + size_t n = points.size(); + VecD predicted; predicted.reserve(n); + VecD deltas; deltas.reserve(n); double maxDelta = 0.0; double variance = 0.0; for (auto& p : points) @@ -227,12 +251,14 @@ inline auto computeLinearRegression(Span points) maxDelta = std::max(maxDelta, fabs(delta)); variance += p.w * delta*delta; } + variance /= wsum * (n<=2? 1 : (n-2)/double(n)); // N-2 because it's an estimation, + // based on 2 other estimated values (socket,gradient) return make_tuple(socket,gradient ,move(predicted) ,move(deltas) ,correlation ,maxDelta - ,sqrt(variance/wsum) + ,sqrt(variance) ); } @@ -251,7 +277,7 @@ inline auto computeLinearRegression(RegressionData const& points) * @return `(socket,gradient)` to describe the regression line y = socket + gradient · i */ template -inline auto computeTimeSeriesLinearRegression(Span series) +inline auto computeTimeSeriesLinearRegression(DataSpan const& series) { auto [ysum,yysum, xysum] = computeStatSums(series); @@ -272,7 +298,7 @@ inline auto computeTimeSeriesLinearRegression(Span series) } inline auto computeTimeSeriesLinearRegression(VecD const& series) -{ return computeTimeSeriesLinearRegression(Span{series}); } +{ return computeTimeSeriesLinearRegression(DataSpan{series}); } From 48d74f261fc9c75077170c59ed9d7db8c26b8178 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Fri, 8 Oct 2021 02:48:23 +0200 Subject: [PATCH 11/13] heuristics to establish a tolerance band for watching global trends After the individual tests, we calculate the averaged delta over the whole test suite, to detect changes to the overall timings. As it turned out, using the error propagation for the calculation of the averaged delta yields the right tolerance band to ignore random fluctuations but trigger alarm on real changes. Moreover, add several further timing test cases to verify the calibration via "platform model" works as intended --- yoshimi-testrunner/src/util/statistic.hpp | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp index d5768619c..80c1a12d7 100644 --- a/yoshimi-testrunner/src/util/statistic.hpp +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -106,6 +106,15 @@ public: +/** summation of variances, for error propagation: √Σe² */ +template +inline double errorSum(NUMS ...vals) +{ + auto sqr = [](auto val){ return val*val; }; + return sqrt((sqr(vals)+ ... + 0.0)); +} + + template inline double average(DataSpan const& data) @@ -149,7 +158,7 @@ inline double averageLastN(VecD const& data, size_t n) return average(lastN(data,n)); } -inline double sdevLastN(VecD const& data, double mean, size_t n) +inline double sdevLastN(VecD const& data, size_t n, double mean) { return sdev(lastN(data,n), mean); } @@ -234,7 +243,7 @@ inline auto computeLinearRegression(DataSpan const& points) double socket = ym - gradient * xm; // Regression line: Y-ym = gradient · (x-xm) ; set x≔0 yields socket // Correlation (Pearson's r) - double correlation = gradient * sqrt(varx/vary); + double correlation = wyysum==0.0? 0.0 : gradient * sqrt(varx/vary); // calculate error Δ for all measurement points size_t n = points.size(); @@ -279,6 +288,8 @@ inline auto computeLinearRegression(RegressionData const& points) template inline auto computeTimeSeriesLinearRegression(DataSpan const& series) { + if (series.size() < 2) return make_tuple(0.0,0.0,0.0); + auto [ysum,yysum, xysum] = computeStatSums(series); size_t n = series.size(); @@ -293,7 +304,7 @@ inline auto computeTimeSeriesLinearRegression(DataSpan const& series) double socket = ym - gradient * im; // Regression line: Y-ym = Gradient · (i-im) ; set i≔0 yields socket // Correlation (Pearson's r) - double correlation = gradient * sqrt(varx/vary); + double correlation = yysum==0.0? 0.0 : gradient * sqrt(varx/vary); return make_tuple(socket,gradient,correlation); } From ef91088fb7b26d66ddcf3987daf68e4f47726e39 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Sat, 9 Oct 2021 17:38:37 +0200 Subject: [PATCH 12/13] Documentation clean-up and fixes more clean-up and polishing after some further test regarding the topic of timing measurements Improved handling: filter test cases to be performed --- yoshimi-testrunner/src/util/data.hpp | 12 +++++++++ yoshimi-testrunner/src/util/regex.hpp | 32 ++++++++++++++++++++++- yoshimi-testrunner/src/util/statistic.hpp | 4 +-- 3 files changed, 45 insertions(+), 3 deletions(-) diff --git a/yoshimi-testrunner/src/util/data.hpp b/yoshimi-testrunner/src/util/data.hpp index f3e0b3e12..8dd3d7589 100644 --- a/yoshimi-testrunner/src/util/data.hpp +++ b/yoshimi-testrunner/src/util/data.hpp @@ -253,6 +253,17 @@ public: }); } + void dropLastRow() + { + if (not empty()) + forEach(TAB::allColumns(), + [](auto& col) + { + size_t siz = col.data.size(); + col.data.resize(siz>0? siz-1 : 0); + }); + } + void reserve(size_t expectedCapacity) { forEach(TAB::allColumns(), @@ -282,6 +293,7 @@ public: fs::rename(filename_, oldFile); } fs::rename(newFilename, filename_); + filename_ = consolidated(filename_); // lock onto absolute path } diff --git a/yoshimi-testrunner/src/util/regex.hpp b/yoshimi-testrunner/src/util/regex.hpp index 1aae85bc0..169a75b55 100644 --- a/yoshimi-testrunner/src/util/regex.hpp +++ b/yoshimi-testrunner/src/util/regex.hpp @@ -32,9 +32,12 @@ #include #include +#include namespace util { +using std::regex; +using std::smatch; using std::string; @@ -43,7 +46,7 @@ using std::string; struct MatchSeq : std::sregex_iterator { - MatchSeq(string const& toParse, std::regex const& regex) + MatchSeq(string const& toParse, regex const& regex) : std::sregex_iterator{toParse.begin(), toParse.end(), regex} { } @@ -53,5 +56,32 @@ struct MatchSeq }; + +/** encapsulated regex buildable from string */ +class Matcher +{ + std::optional pattern_; + +public: + Matcher() = default; + Matcher(string const& regexDefinition) + : pattern_{regexDefinition.empty()? std::nullopt + : std::make_optional(regexDefinition, regex::optimize)} + { } + // standard copy acceptable + + explicit operator bool() const + { + return bool(pattern_); + } + + bool matchesWithin(string probe) const + { + return pattern_? std::regex_search(probe, *pattern_) + : true; // undefined pattern matches everything + } +}; + + }//(End)namespace util #endif /*TESTRUNNER_UTIL_REGEX_HPP_*/ diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp index 80c1a12d7..c2ab6bb96 100644 --- a/yoshimi-testrunner/src/util/statistic.hpp +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -243,7 +243,7 @@ inline auto computeLinearRegression(DataSpan const& points) double socket = ym - gradient * xm; // Regression line: Y-ym = gradient · (x-xm) ; set x≔0 yields socket // Correlation (Pearson's r) - double correlation = wyysum==0.0? 0.0 : gradient * sqrt(varx/vary); + double correlation = wyysum==0.0? 1.0 : gradient * sqrt(varx/vary); // calculate error Δ for all measurement points size_t n = points.size(); @@ -304,7 +304,7 @@ inline auto computeTimeSeriesLinearRegression(DataSpan const& series) double socket = ym - gradient * im; // Regression line: Y-ym = Gradient · (i-im) ; set i≔0 yields socket // Correlation (Pearson's r) - double correlation = yysum==0.0? 0.0 : gradient * sqrt(varx/vary); + double correlation = yysum==0.0? 1.0 : gradient * sqrt(varx/vary); return make_tuple(socket,gradient,correlation); } From fda24faa73dfed2442ddf02ab13162ad8db26547 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Sat, 23 Apr 2022 18:57:47 +0200 Subject: [PATCH 13/13] add a rounding helper ...as part of: Breaking Change: adapt runtime.csv storage to improve readability --- yoshimi-testrunner/src/util/statistic.hpp | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yoshimi-testrunner/src/util/statistic.hpp b/yoshimi-testrunner/src/util/statistic.hpp index c2ab6bb96..06386015c 100644 --- a/yoshimi-testrunner/src/util/statistic.hpp +++ b/yoshimi-testrunner/src/util/statistic.hpp @@ -59,6 +59,13 @@ constexpr auto array_from_tuple(TUP&& tuple) return std::apply(makeArray, std::forward(tuple)); } +template +inline double round(double val) +{ + constexpr double shiftFac = pow(10.0,places); + return std::round(val * shiftFac)/shiftFac; +} +