Compare commits
No commits in common. "main" and "0.1.0" have entirely different histories.
@ -1,34 +0,0 @@
|
|||||||
name: Deploy MkDocs to Garage
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main # Adjust to your branch name
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-and-deploy:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Python
|
|
||||||
uses: actions/setup-python@v4
|
|
||||||
with:
|
|
||||||
python-version: '3.x'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: pip install mkdocs-material
|
|
||||||
|
|
||||||
- name: Build
|
|
||||||
run: mkdocs build
|
|
||||||
|
|
||||||
- name: Sync to Garage S3
|
|
||||||
uses: https://github.com/jakejarvis/s3-sync-action@master
|
|
||||||
with:
|
|
||||||
args: --endpoint-url https://s3.garage.bouvais.lu --acl public-read --delete
|
|
||||||
env:
|
|
||||||
AWS_S3_BUCKET: 'zig-dimal.bouvais.lu'
|
|
||||||
AWS_ACCESS_KEY_ID: ${{ secrets.GARAGE_ACCESS_KEY }}
|
|
||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.GARAGE_SECRET_KEY }}
|
|
||||||
AWS_REGION: 'garage'
|
|
||||||
SOURCE_DIR: 'site' # MkDocs defaults to 'site' folder for output
|
|
||||||
674
LICENSE
674
LICENSE
@ -1,674 +0,0 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
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.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
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 <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
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
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
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
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
322
README.md
322
README.md
@ -1,66 +1,60 @@
|
|||||||
# dimal — Dimensional Analysis for Zig
|
# dimal — Dimensional Analysis for Zig
|
||||||
|
|
||||||
A dimensional analysis library for Zig with a unified `Tensor` API for scalars, vectors, matrices, and higher-dimensional data. All dimension and unit tracking happens at compile time—zero runtime overhead—and all operations use SIMD intrinsics.
|
A comptime-first dimensional analysis module for Zig. If you try to add meters to seconds, **it won't compile**. That's the point.
|
||||||
|
|
||||||
If you try to add meters to seconds, it won't compile. That's the point.
|
Born from a space simulation where `i128` positions were needed to avoid float imprecision far from the origin, this module grew into a full physical-unit type system with zero runtime overhead.
|
||||||
|
|
||||||
> **Source:** [git.bouvais.lu/adrien/zig-dimal](https://git.bouvais.lu/adrien/zig-dimal)
|
> **Source:** [git.bouvais.lu/adrien/zig-dimal](https://git.bouvais.lu/adrien/zig-dimal)
|
||||||
> **Minimum Zig version:** `0.16.0`
|
> **Minimum Zig version:** `0.16.0`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Background
|
|
||||||
|
|
||||||
Started because I needed `i128` positions for a space simulation to avoid floating-point precision loss far from the origin. Grew into a type system for tracking physical dimensions at compile time. It's been useful enough to share.
|
|
||||||
|
|
||||||
- **Compile-time dimension checking** — catch unit mismatches before runtime.
|
|
||||||
- **Unified `Tensor` API** — same interface for scalars, vectors, matrices, and higher-rank tensors.
|
|
||||||
- **SIMD operations** — vector and matrix code automatically uses SIMD instructions.
|
|
||||||
- **Zero runtime cost** — all dimension and scale tracking is erased at compile time.
|
|
||||||
- **Supports `i128`** — useful for high-precision fixed-point integer math.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Compile-time dimension checking** — all physical-unit tracking happens at compile time.
|
- **100% comptime** — all dimension and unit tracking happens at compile time. No added memory, *almost* native performance.
|
||||||
|
- **Compile-time dimension errors** — adding `Meter` to `Second` is a compile error, not a runtime panic.
|
||||||
- **Automatic unit conversion** — use `.to()` to convert between compatible units (e.g. `km/h` → `m/s`). Scale factors are resolved at comptime.
|
- **Automatic unit conversion** — use `.to()` to convert between compatible units (e.g. `km/h` → `m/s`). Scale factors are resolved at comptime.
|
||||||
- **Unified `Tensor` API** — one type for scalars `{1}`, vectors `{N}`, matrices `{M, N}`, and higher-rank tensors.
|
- **Full SI prefix support** — `pico`, `nano`, `micro`, `milli`, `centi`, `deci`, `kilo`, `mega`, `giga`, `tera`, `peta`, and more.
|
||||||
- **SIMD operations** — vector and matrix code compiles to SIMD instructions automatically.
|
- **Time scale support** — `min`, `hour`, `year` built in.
|
||||||
- **Tensor contraction** — `.contract(other, axis_a, axis_b)` for dot products, matrix multiplication, and general tensor contractions.
|
- **Scalar and Vector types** — operate on individual values or fixed-size arrays with the same dimensional safety.
|
||||||
- **Full SI prefix support** — `pico` through `peta`, plus Imperial units and time scales.
|
- **Built-in physical quantities** — `dma.Base` provides ready-made types for `Velocity`, `Acceleration`, `Force`, `Energy`, `Pressure`, `ElectricCharge`, `ThermalConductivity`, and many more.
|
||||||
- **Physical constants** — Planck, Boltzmann, speed of light, gravitational constant, etc.
|
- **Rich formatting** — values print with their unit automatically: `9.81m.s⁻²`, `42m.kg.s⁻¹`, `0.172km`.
|
||||||
- **Pre-built quantities** — `Velocity`, `Acceleration`, `Force`, `Energy`, `Pressure`, `Charge`, and more.
|
- **`i128` support** — the whole reason this exists. Use large integers for high-precision fixed-point positions without manual conversion.
|
||||||
- **Basic vector operations** — cross product, length/magnitude, element-wise arithmetic.
|
- **Tests and benchmarks included** — run them and see how it performs on your machine (results welcome!).
|
||||||
- **Formatting** — values print with units: `9.81m.s⁻²`, `0.172km`.
|
|
||||||
|
|
||||||
### Current Limitations
|
|
||||||
|
|
||||||
- GPU support not implemented.
|
|
||||||
- Performance on small tensors is limited by Zig's vector width.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## The 7 SI Base Dimensions
|
## The 7 SI Base Dimensions
|
||||||
|
|
||||||
| Symbol | Dimension | SI Unit |
|
| Symbol | Dimension | SI Unit |
|
||||||
|--------|----------------------|---------|
|
|--------|----------------------|----------|
|
||||||
| `L` | Length | `m` |
|
| `L` | Length | `m` |
|
||||||
| `M` | Mass | `g` |
|
| `M` | Mass | `g` |
|
||||||
| `T` | Time | `s` |
|
| `T` | Time | `s` |
|
||||||
| `I` | Electric Current | `A` |
|
| `I` | Electric Current | `A` |
|
||||||
| `Tr` | Temperature | `K` |
|
| `Tp` | Temperature | `K` |
|
||||||
| `N` | Amount of Substance | `mol` |
|
| `N` | Amount of Substance | `mol` |
|
||||||
| `J` | Luminous Intensity | `cd` |
|
| `J` | Luminous Intensity | `cd` |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### 1. Add the dependency (Zig 0.14+)
|
### 1. Fetch the dependency
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
zig fetch --save git+https://git.bouvais.lu/adrien/zig-dimal#0.2.0
|
zig fetch --save git+https://git.bouvais.lu/adrien/zig-dimal#b9647e04266e3f395cfd26b41622b0c119a1e5be
|
||||||
|
```
|
||||||
|
|
||||||
|
This will add the following to your `build.zig.zon` automatically:
|
||||||
|
|
||||||
|
```zig
|
||||||
|
.dependencies = .{
|
||||||
|
.dimal = .{
|
||||||
|
.url = "git+https://git.bouvais.lu/adrien/zig-dimal#b9647e04266e3f395cfd26b41622b0c119a1e5be",
|
||||||
|
.hash = "dimal-0.1.0-WNhSHvomAQAX1ISvq9ZBal-Gam6078y8hE67aC82l63V",
|
||||||
|
},
|
||||||
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Wire it up in `build.zig`
|
### 2. Wire it up in `build.zig`
|
||||||
@ -70,181 +64,167 @@ const std = @import("std");
|
|||||||
|
|
||||||
pub fn build(b: *std.Build) void {
|
pub fn build(b: *std.Build) void {
|
||||||
const target = b.standardTargetOptions(.{});
|
const target = b.standardTargetOptions(.{});
|
||||||
const optimize = b.standardOptimizeOption(.{});
|
const dimal = b.dependency("dimal", .{}).module("dimal");
|
||||||
|
|
||||||
const dimal = b.dependency("dimal", .{
|
|
||||||
.target = target,
|
|
||||||
.optimize = optimize,
|
|
||||||
}).module("dimal");
|
|
||||||
|
|
||||||
const exe = b.addExecutable(.{
|
const exe = b.addExecutable(.{
|
||||||
.name = "my_app",
|
.name = "my_project",
|
||||||
.root_source_file = b.path("src/main.zig"),
|
.root_module = b.createModule(.{
|
||||||
.target = target,
|
.root_source_file = b.path("src/main.zig"),
|
||||||
.optimize = optimize,
|
.target = target,
|
||||||
|
.imports = &.{.{
|
||||||
|
.name = "dimal",
|
||||||
|
.module = dimal,
|
||||||
|
}},
|
||||||
|
}),
|
||||||
});
|
});
|
||||||
exe.root_module.addImport("dimal", dimal);
|
|
||||||
b.installArtifact(exe);
|
b.installArtifact(exe);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Import and use
|
### 3. Import in your code
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const dma = @import("dimal");
|
const dma = @import("dimal");
|
||||||
const Tensor = dma.Tensor;
|
const Scalar = dma.Scalar;
|
||||||
const Base = dma.Base;
|
const Dimensions = dma.Dimensions;
|
||||||
|
const Scales = dma.Scales;
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Quick Example: Lunar Descent
|
## Quick Start
|
||||||
|
|
||||||
Simulate a spacecraft descending to the Moon with correct physics and type safety:
|
### Defining unit types
|
||||||
|
|
||||||
|
A `Scalar` type is parameterized by three things: the numeric type (`f64`, `i128`, …), the dimensions (which physical quantities, and their exponents), and the scales (SI prefixes or custom time units).
|
||||||
|
|
||||||
```zig
|
```zig
|
||||||
const std = @import("std");
|
const Meter = Scalar(f64, .init(.{ .L = 1 }), .init(.{}));
|
||||||
const dma = @import("dimal");
|
const NanoMeter = Scalar(i64, .init(.{ .L = 1 }), .init(.{ .L = .n }));
|
||||||
const Tensor = dma.Tensor;
|
const KiloMeter = Scalar(f64, .init(.{ .L = 1 }), .init(.{ .L = .k }));
|
||||||
|
const Second = Scalar(f64, .init(.{ .T = 1 }), .init(.{}));
|
||||||
pub fn main() void {
|
const Velocity = Scalar(f64, .init(.{ .L = 1, .T = -1 }), .init(.{}));
|
||||||
// Define types: m/s² acceleration, m/s velocity, m distance
|
const Kmh = Scalar(f64, .init(.{ .L = 1, .T = -1 }), .init(.{ .L = .k, .T = .hour }));
|
||||||
const Acceleration = dma.Base.Acceleration.Of(f64);
|
|
||||||
const Velocity = dma.Base.Velocity.Of(f64);
|
|
||||||
const Distance = dma.Base.Meter.Of(f64);
|
|
||||||
const Time = dma.Base.Second.Of(f64);
|
|
||||||
|
|
||||||
// Initial conditions
|
|
||||||
const g_moon: Acceleration = .{ .data = @splat(1.62) };
|
|
||||||
const v_initial: Velocity = .{ .data = @splat(100.0) };
|
|
||||||
const h_initial: Distance = .{ .data = @splat(10000.0) };
|
|
||||||
const dt: Time = .{ .data = @splat(1.0) };
|
|
||||||
|
|
||||||
var h = h_initial;
|
|
||||||
var v = v_initial;
|
|
||||||
var t: f64 = 0;
|
|
||||||
|
|
||||||
// Simulate descent
|
|
||||||
while (h.data[0] > 0 and t < 1000) : (t += 1.0) {
|
|
||||||
// a = -g (gravity pulls down)
|
|
||||||
const a = g_moon.mul(-1.0);
|
|
||||||
|
|
||||||
// Update: v = v₀ + at
|
|
||||||
v = v.add(a.mul(dt));
|
|
||||||
|
|
||||||
// Update: h = h₀ + vt
|
|
||||||
h = h.add(v.mul(dt));
|
|
||||||
|
|
||||||
if (@mod(t, 100.0) == 0) {
|
|
||||||
std.debug.print("t={d:.0}s | h={d:.1} | v={d:.1}\n", .{
|
|
||||||
t,
|
|
||||||
h,
|
|
||||||
v,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
std.debug.print("Landed in {d:.1}s at h={d:.1}\n", .{ t, h });
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Output:**
|
Or use the pre-built helpers from `dma.Base`:
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const Acceleration = dma.Base.Acceleration.Of(f64);
|
||||||
|
const KmhSpeed = dma.Base.Speed.Scaled(f64, Scales.init(.{ .L = .k, .T = .hour }));
|
||||||
```
|
```
|
||||||
t=0s | h=10000m | v=100m.s⁻¹
|
|
||||||
t=100s | h=8019m | v=-61.8m.s⁻¹
|
### Kinematics example
|
||||||
t=200s | h=4174.4m | v=-223.6m.s⁻¹
|
|
||||||
...
|
```zig
|
||||||
Landed in 323.5s at h=-0.01m
|
const v0 = Velocity{ .value = 10.0 }; // 10 m/s
|
||||||
|
const accel = Acceleration{ .value = 9.81 }; // 9.81 m/s²
|
||||||
|
const time = Second{ .value = 5.0 }; // 5 s
|
||||||
|
|
||||||
|
// d = v₀t + ½at²
|
||||||
|
const d1 = v0.mulBy(time); // → Meter
|
||||||
|
const d2 = accel.mulBy(time.mulBy(time)).scale(0.5); // → Meter
|
||||||
|
const dist = d1.add(d2);
|
||||||
|
|
||||||
|
const v_final = v0.add(accel.mulBy(time));
|
||||||
|
|
||||||
|
std.debug.print("Distance: {d} | {d}\n", .{ dist, dist.to(KiloMeter) });
|
||||||
|
// Distance: 172.625m | 0.172625km
|
||||||
|
|
||||||
|
std.debug.print("Final speed: {d:.2}\n", .{v_final});
|
||||||
|
// Final speed: 59.05m.s⁻¹
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Unit conversion
|
||||||
|
|
||||||
|
`.to()` converts between compatible units at comptime. Mixing incompatible dimensions is a **compile error**.
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const speed_kmh = Kmh{ .value = 120.0 };
|
||||||
|
const speed_ms = speed_kmh.to(Velocity); // 33.333... m/s — comptime ratio
|
||||||
|
|
||||||
|
// This would NOT compile:
|
||||||
|
// const bad = speed_kmh.to(Second); // "Dimension mismatch in to: L1T-1 vs T1"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Working with Vectors
|
||||||
|
|
||||||
|
Every `Scalar` type exposes a `.Vec3` and a generic `.Vec(n)`:
|
||||||
|
|
||||||
|
```zig
|
||||||
|
const Vec3Meter = Meter.Vec3; // or: Vector(3, Meter)
|
||||||
|
|
||||||
|
const pos = Vec3Meter{ .data = .{ 100, 200, 300 } };
|
||||||
|
const t = Second{ .value = 10 };
|
||||||
|
|
||||||
|
const vel = pos.divByScalar(t); // → Vec3 of Velocity (m/s)
|
||||||
|
|
||||||
|
std.debug.print("{d}\n", .{vel}); // (10, 20, 30)m.s⁻¹
|
||||||
|
```
|
||||||
|
|
||||||
|
Vectors support: `add`, `sub`, `mulBy`, `divBy`, `mulByScalar`, `divByScalar`, `negate`, `to`, `length`, `lengthSqr`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## API Overview
|
## API Reference
|
||||||
|
|
||||||
### Tensors
|
### `Scalar(T, dims, scales)`
|
||||||
|
|
||||||
A **`Tensor`** is parameterized by:
|
| Method | Description |
|
||||||
- **`T`** — numeric type: `f32`, `f64`, `i128`, etc.
|
|---|---|
|
||||||
- **`dims`** — physical dimensions (struct literal): `.{.L = 1, .T = -1}` means length/time (velocity).
|
| `.add(rhs)` | Add two quantities of the same dimension. Auto-converts scales. |
|
||||||
- **`scales`** — SI prefixes or custom scales: `.{.L = .k, .T = .hour}` means km/h.
|
| `.sub(rhs)` | Subtract. Auto-converts scales. |
|
||||||
- **`shape`** — array shape: `&.{1}` is a scalar, `&.{3}` is a 3-vector, `&.{3, 3}` is a 3×3 matrix.
|
| `.mulBy(rhs)` | Multiply — dimensions are **summed**. `m * s⁻¹` → `m·s⁻¹`. |
|
||||||
|
| `.divBy(rhs)` | Divide — dimensions are **subtracted**. `m / s` → `m·s⁻¹`. |
|
||||||
|
| `.to(DestType)` | Convert to another unit of the same dimension. Compile error on mismatch. |
|
||||||
|
| `.vec3()` | Wrap the value in a `Vec3` of the same type. |
|
||||||
|
| `.Vec(n)` | Get the `Vector(n, Self)` type. |
|
||||||
|
|
||||||
```zig
|
### `dma.Base` — Pre-built quantities
|
||||||
// Scalar: 1-element tensor
|
|
||||||
const Meter = Tensor(f64, .{.L = 1}, .{}, &.{1});
|
|
||||||
const m = Meter{ .data = @splat(5.0) };
|
|
||||||
|
|
||||||
// Vector: N-element tensor (SIMD)
|
A selection of what's available (call `.Of(T)` for base units, `.Scaled(T, scales)` for custom scales):
|
||||||
const Vec3Meter = Tensor(f64, .{.L = 1}, .{}, &.{3});
|
|
||||||
const v = Vec3Meter{ .data = @shuffle(f64, [_]f64{1, 2, 3}, [_]f64 undefined, [_]i32{0, 1, 2, 0, 0, 0}) };
|
|
||||||
|
|
||||||
// Matrix: M×N tensor (SIMD-accelerated)
|
`Meter`, `Second`, `Gramm`, `Kelvin`, `ElectricCurrent`, `Speed`, `Acceleration`, `Inertia`, `Force`, `Pressure`, `Energy`, `Power`, `Area`, `Volume`, `Density`, `Frequency`, `Viscosity`, `ElectricCharge`, `ElectricPotential`, `ElectricResistance`, `MagneticFlux`, `ThermalCapacity`, `ThermalConductivity`, and more.
|
||||||
const Mat3x3Velocity = Tensor(f32, .{.L = 1, .T = -1}, .{}, &.{3, 3});
|
|
||||||
const m_vel = Mat3x3Velocity{ .data = @splat(10.0) };
|
|
||||||
|
|
||||||
// Higher-rank tensor
|
### `Scales` — SI prefixes
|
||||||
const Rank4 = Tensor(f64, .{.M = 1}, .{}, &.{2, 3, 4, 5});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Common Operations
|
| Tag | Factor |
|
||||||
|
|---|---|
|
||||||
| Operation | Description |
|
| `.P` | 10¹⁵ |
|
||||||
|-----------|-------------|
|
| `.T` | 10¹² |
|
||||||
| `.add(rhs)` | Element-wise addition. Auto-converts scales. |
|
| `.G` | 10⁹ |
|
||||||
| `.sub(rhs)` | Element-wise subtraction. |
|
| `.M` | 10⁶ |
|
||||||
| `.mul(rhs)` | Multiply; dimensions are summed. `rhs` can be a tensor or bare number. |
|
| `.k` | 10³ |
|
||||||
| `.div(rhs)` | Divide; dimensions are subtracted. |
|
| `.none` | 1 |
|
||||||
| `.contract(other, axis_a, axis_b)` | Tensor contraction: dot product, matrix multiply, or general N-D contraction. |
|
| `.c` | 10⁻² |
|
||||||
| `.cross(rhs)` | Cross product (3-vectors only). Returns a 3-vector. |
|
| `.m` | 10⁻³ |
|
||||||
| `.length()` / `.lengthSqr()` | Euclidean length (or squared length) of a vector. Returns a scalar `T`. |
|
| `.u` | 10⁻⁶ |
|
||||||
| `.product()` | Multiply all elements. Returns a scalar with combined dimensions. |
|
| `.n` | 10⁻⁹ |
|
||||||
| `.abs()` | Element-wise absolute value. Dimensions unchanged. |
|
| `.p` | 10⁻¹² |
|
||||||
| `.pow(exp)` | Raise to comptime exponent. Dimension exponents multiplied by `exp`. |
|
| `.f` | 10⁻¹⁵ |
|
||||||
| `.sqrt()` | Element-wise square root. Compile error if any dimension exponent is odd. |
|
| `.min` | 60 |
|
||||||
| `.to(DestType)` | Convert to another unit of the same dimension. Comptime error on mismatch. |
|
| `.hour` | 3600 |
|
||||||
| `.eq(rhs)` / `.ne(rhs)` | Element-wise equality/inequality. |
|
| `.year` | 31 536 000 |
|
||||||
| `.gt(rhs)` / `.gte(rhs)` | Greater-than comparisons. |
|
|
||||||
| `.lt(rhs)` / `.lte(rhs)` | Less-than comparisons. |
|
|
||||||
|
|
||||||
### Pre-built Types (via `dma.Base`)
|
|
||||||
|
|
||||||
Use `.Of(T)` for base units, `.Scaled(T, scales)` for custom scales:
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Velocity = dma.Base.Velocity.Of(f64);
|
|
||||||
const Kmh = dma.Base.Velocity.Scaled(f64, .{.L = .k, .T = .hour});
|
|
||||||
const Force = dma.Base.Force.Of(f32);
|
|
||||||
const Energy = dma.Base.Energy.Of(f64);
|
|
||||||
```
|
|
||||||
|
|
||||||
Also available: `Acceleration`, `Inertia`, `Pressure`, `Power`, `Area`, `Volume`, `Density`, `Frequency`, `Viscosity`, `Charge`, `Potential`, `Resistance`, `MagneticFlux`, `ThermalCapacity`, `ThermalConductivity`, and many more.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## SIMD Performance
|
## Running Tests and Benchmarks
|
||||||
|
|
||||||
Operations on vectors and matrices use Zig's `@Vector` intrinsics, which compile to SIMD instructions on most platforms. This makes vector operations faster than equivalent scalar loops, but don't expect miracles—SIMD is still limited by memory bandwidth and CPU cache.
|
|
||||||
|
|
||||||
Run the included benchmarks to see what you get on your hardware:
|
|
||||||
```sh
|
```sh
|
||||||
|
zig build test
|
||||||
zig build benchmark
|
zig build benchmark
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
Benchmark results are very welcome — feel free to share yours!
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **GPU support** — eventually, for large tensor operations. WebGPU is a target.
|
|
||||||
- **Toy physics language** — I've been sketching ideas for a language optimized for numerical physics (tentatively called Éclat). It would use dimal as the foundation. No timeline yet; this is a long-term experiment.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Testing & Benchmarks
|
## Roadmap / Known Limitations
|
||||||
|
|
||||||
```sh
|
- More operations beyond `add`, `sub`, `mulBy`, `divBy` (e.g. `pow`, `sqrt`).
|
||||||
zig build test # Run all unit tests
|
- SIMD acceleration for `Vector` operations.
|
||||||
zig build benchmark # Run performance benchmarks
|
- Some paths may still fall back to runtime computation — optimization ongoing.
|
||||||
```
|
- More test coverage.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@ const std = @import("std");
|
|||||||
|
|
||||||
pub fn build(b: *std.Build) void {
|
pub fn build(b: *std.Build) void {
|
||||||
const target = b.standardTargetOptions(.{});
|
const target = b.standardTargetOptions(.{});
|
||||||
const optimize = b.standardOptimizeOption(.{ .preferred_optimize_mode = .ReleaseFast });
|
const optimize = b.standardOptimizeOption(.{});
|
||||||
|
|
||||||
// 1. Define the module so other projects can import it
|
// 1. Define the module so other projects can import it
|
||||||
_ = b.addModule("dimal", .{
|
_ = b.addModule("dimal", .{
|
||||||
|
|||||||
@ -1,11 +0,0 @@
|
|||||||
- Changed Quantity to Tensor that can use any shape and is a single @Vector.
|
|
||||||
Point being to add WebGPU easily from this.
|
|
||||||
Scalr suffer in performance tho, I will work on that
|
|
||||||
|
|
||||||
Maybe I can do a jupiter like web interface with cells to make Dim analysis
|
|
||||||
I could:
|
|
||||||
- Use cells with a toy language
|
|
||||||
- A nice debugger to display current variables with dimensions, type and value
|
|
||||||
- Realtime error (I try to compile at change, display error on the cell)
|
|
||||||
- Integrate a small graphic API that use Raylib canvas
|
|
||||||
- COuld generate template at comptime =o
|
|
||||||
253
docs/index.md
253
docs/index.md
@ -1,253 +0,0 @@
|
|||||||
# dimal — Dimensional Analysis for Zig
|
|
||||||
|
|
||||||
A dimensional analysis library for Zig with a unified `Tensor` API for scalars, vectors, matrices, and higher-dimensional data. All dimension and unit tracking happens at compile time—zero runtime overhead—and all operations use SIMD intrinsics.
|
|
||||||
|
|
||||||
If you try to add meters to seconds, it won't compile. That's the point.
|
|
||||||
|
|
||||||
> **Source:** [git.bouvais.lu/adrien/zig-dimal](https://git.bouvais.lu/adrien/zig-dimal)
|
|
||||||
> **Minimum Zig version:** `0.16.0`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Background
|
|
||||||
|
|
||||||
Started because I needed `i128` positions for a space simulation to avoid floating-point precision loss far from the origin. Grew into a type system for tracking physical dimensions at compile time. It's been useful enough to share.
|
|
||||||
|
|
||||||
- **Compile-time dimension checking** — catch unit mismatches before runtime.
|
|
||||||
- **Unified `Tensor` API** — same interface for scalars, vectors, matrices, and higher-rank tensors.
|
|
||||||
- **SIMD operations** — vector and matrix code automatically uses SIMD instructions.
|
|
||||||
- **Zero runtime cost** — all dimension and scale tracking is erased at compile time.
|
|
||||||
- **Supports `i128`** — useful for high-precision fixed-point integer math.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- **Compile-time dimension checking** — all physical-unit tracking happens at compile time.
|
|
||||||
- **Automatic unit conversion** — use `.to()` to convert between compatible units (e.g. `km/h` → `m/s`). Scale factors are resolved at comptime.
|
|
||||||
- **Unified `Tensor` API** — one type for scalars `{1}`, vectors `{N}`, matrices `{M, N}`, and higher-rank tensors.
|
|
||||||
- **SIMD operations** — vector and matrix code compiles to SIMD instructions automatically.
|
|
||||||
- **Tensor contraction** — `.contract(other, axis_a, axis_b)` for dot products, matrix multiplication, and general tensor contractions.
|
|
||||||
- **Full SI prefix support** — `pico` through `peta`, plus Imperial units and time scales.
|
|
||||||
- **Physical constants** — Planck, Boltzmann, speed of light, gravitational constant, etc.
|
|
||||||
- **Pre-built quantities** — `Velocity`, `Acceleration`, `Force`, `Energy`, `Pressure`, `Charge`, and more.
|
|
||||||
- **Basic vector operations** — cross product, length/magnitude, element-wise arithmetic.
|
|
||||||
- **Formatting** — values print with units: `9.81m.s⁻²`, `0.172km`.
|
|
||||||
|
|
||||||
### Current Limitations
|
|
||||||
|
|
||||||
- GPU support not implemented.
|
|
||||||
- Performance on small tensors is limited by Zig's vector width.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The 7 SI Base Dimensions
|
|
||||||
|
|
||||||
| Symbol | Dimension | SI Unit |
|
|
||||||
|--------|----------------------|---------|
|
|
||||||
| `L` | Length | `m` |
|
|
||||||
| `M` | Mass | `g` |
|
|
||||||
| `T` | Time | `s` |
|
|
||||||
| `I` | Electric Current | `A` |
|
|
||||||
| `Tr` | Temperature | `K` |
|
|
||||||
| `N` | Amount of Substance | `mol` |
|
|
||||||
| `J` | Luminous Intensity | `cd` |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
### 1. Add the dependency (Zig 0.14+)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
zig fetch --save git+https://git.bouvais.lu/adrien/zig-dimal#0.2.0
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Wire it up in `build.zig`
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const std = @import("std");
|
|
||||||
|
|
||||||
pub fn build(b: *std.Build) void {
|
|
||||||
const target = b.standardTargetOptions(.{});
|
|
||||||
const optimize = b.standardOptimizeOption(.{});
|
|
||||||
|
|
||||||
const dimal = b.dependency("dimal", .{
|
|
||||||
.target = target,
|
|
||||||
.optimize = optimize,
|
|
||||||
}).module("dimal");
|
|
||||||
|
|
||||||
const exe = b.addExecutable(.{
|
|
||||||
.name = "my_app",
|
|
||||||
.root_source_file = b.path("src/main.zig"),
|
|
||||||
.target = target,
|
|
||||||
.optimize = optimize,
|
|
||||||
});
|
|
||||||
exe.root_module.addImport("dimal", dimal);
|
|
||||||
b.installArtifact(exe);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Import and use
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const dma = @import("dimal");
|
|
||||||
const Tensor = dma.Tensor;
|
|
||||||
const Base = dma.Base;
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Example: Lunar Descent
|
|
||||||
|
|
||||||
Simulate a spacecraft descending to the Moon with correct physics and type safety:
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const std = @import("std");
|
|
||||||
const dma = @import("dimal");
|
|
||||||
const Tensor = dma.Tensor;
|
|
||||||
|
|
||||||
pub fn main() void {
|
|
||||||
// Define types: m/s² acceleration, m/s velocity, m distance
|
|
||||||
const Acceleration = dma.Base.Acceleration.Of(f64);
|
|
||||||
const Velocity = dma.Base.Velocity.Of(f64);
|
|
||||||
const Distance = dma.Base.Meter.Of(f64);
|
|
||||||
const Time = dma.Base.Second.Of(f64);
|
|
||||||
|
|
||||||
// Initial conditions
|
|
||||||
const g_moon: Acceleration = .{ .data = @splat(1.62) };
|
|
||||||
const v_initial: Velocity = .{ .data = @splat(100.0) };
|
|
||||||
const h_initial: Distance = .{ .data = @splat(10000.0) };
|
|
||||||
const dt: Time = .{ .data = @splat(1.0) };
|
|
||||||
|
|
||||||
var h = h_initial;
|
|
||||||
var v = v_initial;
|
|
||||||
var t: f64 = 0;
|
|
||||||
|
|
||||||
// Simulate descent
|
|
||||||
while (h.data[0] > 0 and t < 1000) : (t += 1.0) {
|
|
||||||
// a = -g (gravity pulls down)
|
|
||||||
const a = g_moon.mul(-1.0);
|
|
||||||
|
|
||||||
// Update: v = v₀ + at
|
|
||||||
v = v.add(a.mul(dt));
|
|
||||||
|
|
||||||
// Update: h = h₀ + vt
|
|
||||||
h = h.add(v.mul(dt));
|
|
||||||
|
|
||||||
if (@mod(t, 100.0) == 0) {
|
|
||||||
std.debug.print("t={d:.0}s | h={d:.1} | v={d:.1}\n", .{
|
|
||||||
t,
|
|
||||||
h,
|
|
||||||
v,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
std.debug.print("Landed in {d:.1}s at h={d:.1}\n", .{ t, h });
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Output:**
|
|
||||||
```
|
|
||||||
t=0s | h=10000m | v=100m.s⁻¹
|
|
||||||
t=100s | h=8019m | v=-61.8m.s⁻¹
|
|
||||||
t=200s | h=4174.4m | v=-223.6m.s⁻¹
|
|
||||||
...
|
|
||||||
Landed in 323.5s at h=-0.01m
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## API Overview
|
|
||||||
|
|
||||||
### Tensors
|
|
||||||
|
|
||||||
A **`Tensor`** is parameterized by:
|
|
||||||
- **`T`** — numeric type: `f32`, `f64`, `i128`, etc.
|
|
||||||
- **`dims`** — physical dimensions (struct literal): `.{.L = 1, .T = -1}` means length/time (velocity).
|
|
||||||
- **`scales`** — SI prefixes or custom scales: `.{.L = .k, .T = .hour}` means km/h.
|
|
||||||
- **`shape`** — array shape: `&.{1}` is a scalar, `&.{3}` is a 3-vector, `&.{3, 3}` is a 3×3 matrix.
|
|
||||||
|
|
||||||
```zig
|
|
||||||
// Scalar: 1-element tensor
|
|
||||||
const Meter = Tensor(f64, .{.L = 1}, .{}, &.{1});
|
|
||||||
const m = Meter{ .data = @splat(5.0) };
|
|
||||||
|
|
||||||
// Vector: N-element tensor (SIMD)
|
|
||||||
const Vec3Meter = Tensor(f64, .{.L = 1}, .{}, &.{3});
|
|
||||||
const v = Vec3Meter{ .data = @shuffle(f64, [_]f64{1, 2, 3}, [_]f64 undefined, [_]i32{0, 1, 2, 0, 0, 0}) };
|
|
||||||
|
|
||||||
// Matrix: M×N tensor (SIMD-accelerated)
|
|
||||||
const Mat3x3Velocity = Tensor(f32, .{.L = 1, .T = -1}, .{}, &.{3, 3});
|
|
||||||
const m_vel = Mat3x3Velocity{ .data = @splat(10.0) };
|
|
||||||
|
|
||||||
// Higher-rank tensor
|
|
||||||
const Rank4 = Tensor(f64, .{.M = 1}, .{}, &.{2, 3, 4, 5});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Common Operations
|
|
||||||
|
|
||||||
| Operation | Description |
|
|
||||||
|-----------|-------------|
|
|
||||||
| `.add(rhs)` | Element-wise addition. Auto-converts scales. |
|
|
||||||
| `.sub(rhs)` | Element-wise subtraction. |
|
|
||||||
| `.mul(rhs)` | Multiply; dimensions are summed. `rhs` can be a tensor or bare number. |
|
|
||||||
| `.div(rhs)` | Divide; dimensions are subtracted. |
|
|
||||||
| `.contract(other, axis_a, axis_b)` | Tensor contraction: dot product, matrix multiply, or general N-D contraction. |
|
|
||||||
| `.cross(rhs)` | Cross product (3-vectors only). Returns a 3-vector. |
|
|
||||||
| `.length()` / `.lengthSqr()` | Euclidean length (or squared length) of a vector. Returns a scalar `T`. |
|
|
||||||
| `.product()` | Multiply all elements. Returns a scalar with combined dimensions. |
|
|
||||||
| `.abs()` | Element-wise absolute value. Dimensions unchanged. |
|
|
||||||
| `.pow(exp)` | Raise to comptime exponent. Dimension exponents multiplied by `exp`. |
|
|
||||||
| `.sqrt()` | Element-wise square root. Compile error if any dimension exponent is odd. |
|
|
||||||
| `.to(DestType)` | Convert to another unit of the same dimension. Comptime error on mismatch. |
|
|
||||||
| `.eq(rhs)` / `.ne(rhs)` | Element-wise equality/inequality. |
|
|
||||||
| `.gt(rhs)` / `.gte(rhs)` | Greater-than comparisons. |
|
|
||||||
| `.lt(rhs)` / `.lte(rhs)` | Less-than comparisons. |
|
|
||||||
|
|
||||||
### Pre-built Types (via `dma.Base`)
|
|
||||||
|
|
||||||
Use `.Of(T)` for base units, `.Scaled(T, scales)` for custom scales:
|
|
||||||
|
|
||||||
```zig
|
|
||||||
const Velocity = dma.Base.Velocity.Of(f64);
|
|
||||||
const Kmh = dma.Base.Velocity.Scaled(f64, .{.L = .k, .T = .hour});
|
|
||||||
const Force = dma.Base.Force.Of(f32);
|
|
||||||
const Energy = dma.Base.Energy.Of(f64);
|
|
||||||
```
|
|
||||||
|
|
||||||
Also available: `Acceleration`, `Inertia`, `Pressure`, `Power`, `Area`, `Volume`, `Density`, `Frequency`, `Viscosity`, `Charge`, `Potential`, `Resistance`, `MagneticFlux`, `ThermalCapacity`, `ThermalConductivity`, and many more.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## SIMD Performance
|
|
||||||
|
|
||||||
Operations on vectors and matrices use Zig's `@Vector` intrinsics, which compile to SIMD instructions on most platforms. This makes vector operations faster than equivalent scalar loops, but don't expect miracles—SIMD is still limited by memory bandwidth and CPU cache.
|
|
||||||
|
|
||||||
Run the included benchmarks to see what you get on your hardware:
|
|
||||||
```sh
|
|
||||||
zig build benchmark
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **GPU support** — eventually, for large tensor operations. WebGPU is a target.
|
|
||||||
- **Toy physics language** — I've been sketching ideas for a language optimized for numerical physics (tentatively called Éclat). It would use dimal as the foundation. No timeline yet; this is a long-term experiment.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Testing & Benchmarks
|
|
||||||
|
|
||||||
```sh
|
|
||||||
zig build test # Run all unit tests
|
|
||||||
zig build benchmark # Run performance benchmarks
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
See the repository for license details.
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
## GPU support with WebGPU
|
|
||||||
|
|
||||||
Example: https://github.com/seyhajin/webgpu-wasm-zig
|
|
||||||
48
mkdocs.yml
48
mkdocs.yml
@ -1,48 +0,0 @@
|
|||||||
site_name: Bouvais Docs
|
|
||||||
site_url: https://zig-dimal.bouvais.lu
|
|
||||||
site_description: A minimal technical documentation site.
|
|
||||||
site_author: Adrien Bouvais
|
|
||||||
|
|
||||||
theme:
|
|
||||||
name: material
|
|
||||||
language: en
|
|
||||||
# Color palette with auto light/dark mode
|
|
||||||
palette:
|
|
||||||
- media: "(prefers-color-scheme: light)"
|
|
||||||
scheme: default
|
|
||||||
primary: indigo
|
|
||||||
accent: indigo
|
|
||||||
toggle:
|
|
||||||
icon: material/brightness-7
|
|
||||||
name: Switch to dark mode
|
|
||||||
- media: "(prefers-color-scheme: dark)"
|
|
||||||
scheme: slate
|
|
||||||
primary: indigo
|
|
||||||
accent: indigo
|
|
||||||
toggle:
|
|
||||||
icon: material/brightness-4
|
|
||||||
name: Switch to light mode
|
|
||||||
|
|
||||||
features:
|
|
||||||
- navigation.sections
|
|
||||||
- navigation.top
|
|
||||||
- content.code.copy
|
|
||||||
- content.code.annotate
|
|
||||||
|
|
||||||
# Minimal plugins
|
|
||||||
plugins:
|
|
||||||
- search
|
|
||||||
|
|
||||||
# Your single page
|
|
||||||
nav:
|
|
||||||
- Home: index.md
|
|
||||||
|
|
||||||
# Extensions to make your markdown look better
|
|
||||||
markdown_extensions:
|
|
||||||
- admonition
|
|
||||||
- pymdownx.details
|
|
||||||
- pymdownx.superfences
|
|
||||||
- pymdownx.highlight:
|
|
||||||
anchor_linenums: true
|
|
||||||
- pymdownx.inlinehilite
|
|
||||||
- attr_list
|
|
||||||
185
src/Base.zig
185
src/Base.zig
@ -3,97 +3,33 @@ const std = @import("std");
|
|||||||
// Adjust these imports to match your actual file names
|
// Adjust these imports to match your actual file names
|
||||||
const Dimensions = @import("Dimensions.zig");
|
const Dimensions = @import("Dimensions.zig");
|
||||||
const Scales = @import("Scales.zig");
|
const Scales = @import("Scales.zig");
|
||||||
const Tensor = @import("Tensor.zig").Tensor;
|
const Scalar = @import("Scalar.zig").Scalar;
|
||||||
|
|
||||||
fn PhysicalConstant(comptime d: Dimensions.ArgOpts, comptime val: f64, comptime s: Scales.ArgOpts) type {
|
/// Helper function to create a clean namespace for each physical dimension.
|
||||||
return struct {
|
/// It exposes the raw dimensions, and easy type-creators for Base or Scaled variants.
|
||||||
pub const dims = Dimensions.init(d);
|
pub fn BaseScalar(comptime d: anytype) type {
|
||||||
pub const scales = Scales.init(s);
|
|
||||||
|
|
||||||
/// Instantiates the constant into a specific numeric type.
|
|
||||||
pub fn Of(comptime T: type) Tensor(T, d, s, &.{1}) {
|
|
||||||
const casted_val: T = switch (@typeInfo(T)) {
|
|
||||||
.float => @floatCast(val),
|
|
||||||
.int => @intFromFloat(val),
|
|
||||||
else => @compileError("Unsupported type for PhysicalConstant"),
|
|
||||||
};
|
|
||||||
return Tensor(T, d, s, &.{1}).splat(casted_val);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
fn BaseScalar(comptime d: Dimensions.ArgOpts) type {
|
|
||||||
return struct {
|
return struct {
|
||||||
pub const dims = Dimensions.init(d);
|
pub const dims = Dimensions.init(d);
|
||||||
|
|
||||||
/// Creates a Scalar of this dimension using default scales.
|
/// Creates a Scalar of this dimension using default scales.
|
||||||
/// Example: const V = Quantities.Velocity.Of(f32);
|
/// Example: const V = Quantities.Velocity.Base(f32);
|
||||||
pub fn Of(comptime T: type) type {
|
pub fn Of(comptime T: type) type {
|
||||||
return Tensor(T, d, .{}, &.{1});
|
return Scalar(T, dims, Scales.init(.{}));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Creates a Scalar of this dimension using custom scales.
|
/// Creates a Scalar of this dimension using custom scales.
|
||||||
/// Example: const Kmh = Quantities.Velocity.Scaled(f32, .{ .L = .k, .T = .hour });
|
/// Example: const Kmh = Quantities.Velocity.Scaled(f32, Scales.init(.{ .L = .k, .T = .hour }));
|
||||||
pub fn Scaled(comptime T: type, comptime s: Scales.ArgOpts) type {
|
pub fn Scaled(comptime T: type, comptime s: Scales) type {
|
||||||
return Tensor(T, d, s, &.{1});
|
return Scalar(T, dims, s);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// ==========================================
|
pub const Dimless = BaseScalar(.{});
|
||||||
// Physical Constants
|
|
||||||
// ==========================================
|
|
||||||
|
|
||||||
pub const Constants = struct {
|
|
||||||
/// Speed of light in vacuum (c) [m/s]
|
|
||||||
pub const SpeedOfLight = PhysicalConstant(.{ .L = 1, .T = -1 }, 299792458.0, .{});
|
|
||||||
|
|
||||||
/// Planck constant (h) [J⋅s = kg⋅m²⋅s⁻¹]
|
|
||||||
pub const Planck = PhysicalConstant(.{ .M = 1, .L = 2, .T = -1 }, 6.62607015e-34, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Reduced Planck constant (ℏ) [J⋅s]
|
|
||||||
pub const ReducedPlanck = PhysicalConstant(.{ .M = 1, .L = 2, .T = -1 }, 1.054571817e-34, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Boltzmann constant (k_B) [J⋅K⁻¹ = kg⋅m²⋅s⁻²⋅K⁻¹]
|
|
||||||
pub const Boltzmann = PhysicalConstant(.{ .M = 1, .L = 2, .T = -2, .Tp = -1 }, 1.380649e-23, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Newtonian constant of gravitation (G) [m³⋅kg⁻¹⋅s⁻²]
|
|
||||||
pub const Gravitational = PhysicalConstant(.{ .M = -1, .L = 3, .T = -2 }, 6.67430e-11, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Stefan–Boltzmann constant (σ) [W⋅m⁻²⋅K⁻⁴ = kg⋅s⁻³⋅K⁻⁴]
|
|
||||||
pub const StefanBoltzmann = PhysicalConstant(.{ .M = 1, .T = -3, .Tp = -4 }, 5.670374419e-8, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Elementary charge (e) [C = A⋅s]
|
|
||||||
pub const ElementaryCharge = PhysicalConstant(.{ .T = 1, .I = 1 }, 1.602176634e-19, .{});
|
|
||||||
|
|
||||||
/// Vacuum magnetic permeability (μ_0) [N⋅A⁻² = kg⋅m⋅s⁻²⋅A⁻²]
|
|
||||||
pub const VacuumPermeability = PhysicalConstant(.{ .M = 1, .L = 1, .T = -2, .I = -2 }, 1.25663706127e-6, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Vacuum electric permittivity (ε_0) [F⋅m⁻¹ = A²⋅s⁴⋅kg⁻¹⋅m⁻³]
|
|
||||||
pub const VacuumPermittivity = PhysicalConstant(.{ .M = -1, .L = -3, .T = 4, .I = 2 }, 8.8541878188e-12, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Electron mass (m_e) [kg]
|
|
||||||
pub const ElectronMass = PhysicalConstant(.{ .M = 1 }, 9.1093837139e-31, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Proton mass (m_p) [kg]
|
|
||||||
pub const ProtonMass = PhysicalConstant(.{ .M = 1 }, 1.67262192595e-27, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Neutron mass (m_n) [kg]
|
|
||||||
pub const NeutronMass = PhysicalConstant(.{ .M = 1 }, 1.67492750056e-27, .{ .M = .k });
|
|
||||||
|
|
||||||
/// Fine-structure constant (α) [Dimensionless]
|
|
||||||
pub const FineStructure = PhysicalConstant(.{}, 0.0072973525643, .{});
|
|
||||||
|
|
||||||
/// Avogadro constant (N_A) [mol⁻¹]
|
|
||||||
/// Note: Assuming mol is currently treated as dimensionless in the base system,
|
|
||||||
/// otherwise requires adding an `.N` dimension to Dimensions.ArgOpts.
|
|
||||||
pub const Avogadro = PhysicalConstant(.{}, 6.02214076e23, .{});
|
|
||||||
};
|
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Base Quantities
|
// Base Quantities
|
||||||
// ==========================================
|
// ==========================================
|
||||||
pub const Dimless = BaseScalar(.{});
|
|
||||||
pub const Meter = BaseScalar(.{ .L = 1 });
|
pub const Meter = BaseScalar(.{ .L = 1 });
|
||||||
pub const Second = BaseScalar(.{ .T = 1 });
|
pub const Second = BaseScalar(.{ .T = 1 });
|
||||||
pub const Gramm = BaseScalar(.{ .M = 1 });
|
pub const Gramm = BaseScalar(.{ .M = 1 });
|
||||||
@ -112,7 +48,7 @@ pub const ElectricCapacitance = BaseScalar(.{ .T = 4, .L = -2, .M = -1, .I = 2 }
|
|||||||
pub const ElectricImpedance = ElectricResistance;
|
pub const ElectricImpedance = ElectricResistance;
|
||||||
pub const MagneticFlux = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .I = -1 });
|
pub const MagneticFlux = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .I = -1 });
|
||||||
pub const MagneticDensity = BaseScalar(.{ .M = 1, .T = -2, .I = -1 });
|
pub const MagneticDensity = BaseScalar(.{ .M = 1, .T = -2, .I = -1 });
|
||||||
pub const MagneticStrength = BaseScalar(.{ .L = -1, .I = 1 });
|
pub const MagneticStrength = BaseScalar(.{ .L = -1, .I = 1 }); // Fixed typo from MagneticStrengh
|
||||||
pub const MagneticMoment = BaseScalar(.{ .L = 2, .I = 1 });
|
pub const MagneticMoment = BaseScalar(.{ .L = 2, .I = 1 });
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
@ -145,7 +81,7 @@ pub const ThermalHeat = Energy;
|
|||||||
pub const ThermalWork = Energy;
|
pub const ThermalWork = Energy;
|
||||||
pub const ThermalCapacity = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .Tr = -1 });
|
pub const ThermalCapacity = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .Tr = -1 });
|
||||||
pub const ThermalCapacityPerMass = BaseScalar(.{ .L = 2, .T = -2, .Tr = -1 });
|
pub const ThermalCapacityPerMass = BaseScalar(.{ .L = 2, .T = -2, .Tr = -1 });
|
||||||
pub const ThermalFluxDensity = BaseScalar(.{ .M = 1, .T = -3 });
|
pub const ThermalFluxDensity = BaseScalar(.{ .M = 1, .T = -3 }); // Fixed typo from ThermalluxDensity
|
||||||
pub const ThermalConductance = BaseScalar(.{ .M = 1, .L = 2, .T = -3, .Tr = -1 });
|
pub const ThermalConductance = BaseScalar(.{ .M = 1, .L = 2, .T = -3, .Tr = -1 });
|
||||||
pub const ThermalConductivity = BaseScalar(.{ .M = 1, .L = 1, .T = -3, .Tr = -1 });
|
pub const ThermalConductivity = BaseScalar(.{ .M = 1, .L = 1, .T = -3, .Tr = -1 });
|
||||||
pub const ThermalResistance = BaseScalar(.{ .M = -1, .L = -2, .T = 3, .Tr = 1 });
|
pub const ThermalResistance = BaseScalar(.{ .M = -1, .L = -2, .T = 3, .Tr = 1 });
|
||||||
@ -157,104 +93,63 @@ pub const ThermalEntropy = BaseScalar(.{ .M = 1, .L = 2, .T = -2, .Tr = -1 });
|
|||||||
// ==========================================
|
// ==========================================
|
||||||
pub const Frequency = BaseScalar(.{ .T = -1 });
|
pub const Frequency = BaseScalar(.{ .T = -1 });
|
||||||
pub const Viscosity = BaseScalar(.{ .M = 1, .L = -1, .T = -1 });
|
pub const Viscosity = BaseScalar(.{ .M = 1, .L = -1, .T = -1 });
|
||||||
pub const SurfaceTension = BaseScalar(.{ .M = 1, .T = -2 });
|
pub const SurfaceTension = BaseScalar(.{ .M = 1, .T = -2 }); // Corrected from MT-2a
|
||||||
|
|
||||||
// ==========================================
|
|
||||||
// Tests
|
|
||||||
// ==========================================
|
|
||||||
|
|
||||||
test "BaseQuantities - Core dimensions instantiation" {
|
test "BaseQuantities - Core dimensions instantiation" {
|
||||||
// Basic types via generic wrappers
|
// Basic types via generic wrappers
|
||||||
const M = Meter.Of(f32);
|
const M = Meter.Of(f32);
|
||||||
const distance = M.splat(100);
|
const distance = M{ .value = 100.0 };
|
||||||
try std.testing.expectEqual(100.0, distance.data[0]);
|
try std.testing.expectEqual(100.0, distance.value);
|
||||||
try std.testing.expectEqual(1, M.dims.get(.L));
|
try std.testing.expectEqual(1, M.dims.get(.L));
|
||||||
try std.testing.expectEqual(0, M.dims.get(.T));
|
try std.testing.expectEqual(0, M.dims.get(.T));
|
||||||
|
|
||||||
// Test specific scale variants
|
// Test specific scale variants
|
||||||
const Kmh = Speed.Scaled(f32, .{ .L = .k, .T = .hour });
|
const Kmh = Speed.Scaled(f32, Scales.init(.{ .L = .k, .T = .hour }));
|
||||||
const speed = Kmh.splat(120);
|
const speed = Kmh{ .value = 120.0 };
|
||||||
try std.testing.expectEqual(120.0, speed.data[0]);
|
try std.testing.expectEqual(120.0, speed.value);
|
||||||
try std.testing.expectEqual(.k, @TypeOf(speed).scales.get(.L));
|
try std.testing.expectEqual(.k, @TypeOf(speed).scales.get(.L));
|
||||||
try std.testing.expectEqual(.hour, @TypeOf(speed).scales.get(.T));
|
try std.testing.expectEqual(.hour, @TypeOf(speed).scales.get(.T));
|
||||||
}
|
}
|
||||||
|
|
||||||
test "BaseQuantities - Kinematics equations" {
|
test "BaseQuantities - Kinematics equations" {
|
||||||
const d = Meter.Of(f32).splat(50.0);
|
const d = Meter.Of(f32){ .value = 50.0 };
|
||||||
const t = Second.Of(f32).splat(2.0);
|
const t = Second.Of(f32){ .value = 2.0 };
|
||||||
|
|
||||||
// Velocity = Distance / Time
|
// Velocity = Distance / Time
|
||||||
const v = d.div(t);
|
const v = d.divBy(t);
|
||||||
try std.testing.expectEqual(25.0, v.data[0]);
|
try std.testing.expectEqual(25.0, v.value);
|
||||||
try comptime std.testing.expect(Speed.dims.eql(@TypeOf(v).dims));
|
try std.testing.expect(Speed.dims.eql(@TypeOf(v).dims));
|
||||||
|
|
||||||
// Acceleration = Velocity / Time
|
// Acceleration = Velocity / Time
|
||||||
const a = v.div(t);
|
const a = v.divBy(t);
|
||||||
try std.testing.expectEqual(12.5, a.data[0]);
|
try std.testing.expectEqual(12.5, a.value);
|
||||||
try comptime std.testing.expect(Acceleration.dims.eql(@TypeOf(a).dims));
|
try std.testing.expect(Acceleration.dims.eql(@TypeOf(a).dims));
|
||||||
}
|
}
|
||||||
|
|
||||||
test "BaseQuantities - Dynamics (Force and Work)" {
|
test "BaseQuantities - Dynamics (Force and Work)" {
|
||||||
// 10 kg
|
// 10 kg
|
||||||
const m = Gramm.Scaled(f32, .{ .M = .k }).splat(10.0);
|
const m = Gramm.Scaled(f32, Scales.init(.{ .M = .k })){ .value = 10.0 };
|
||||||
// 9.8 m/s^2
|
// 9.8 m/s^2
|
||||||
const a = Acceleration.Of(f32).splat(9.8);
|
const a = Acceleration.Of(f32){ .value = 9.8 };
|
||||||
|
|
||||||
// Force = mass * acceleration
|
// Force = mass * acceleration
|
||||||
const f = m.mul(a);
|
const f = m.mulBy(a);
|
||||||
try std.testing.expectEqual(98, f.data[0]);
|
try std.testing.expectEqual(98000, f.value);
|
||||||
try comptime std.testing.expect(Force.dims.eql(@TypeOf(f).dims));
|
try std.testing.expect(Force.dims.eql(@TypeOf(f).dims));
|
||||||
|
|
||||||
// Energy (Work) = Force * distance
|
// Energy (Work) = Force * distance
|
||||||
const distance = Meter.Of(f32).splat(5.0);
|
const distance = Meter.Of(f32){ .value = 5.0 };
|
||||||
const energy = f.mul(distance);
|
const energy = f.mulBy(distance);
|
||||||
try std.testing.expectEqual(490, energy.data[0]);
|
try std.testing.expectEqual(490000, energy.value);
|
||||||
try comptime std.testing.expect(Energy.dims.eql(@TypeOf(energy).dims));
|
try std.testing.expect(Energy.dims.eql(@TypeOf(energy).dims));
|
||||||
}
|
}
|
||||||
|
|
||||||
test "BaseQuantities - Electric combinations" {
|
test "BaseQuantities - Electric combinations" {
|
||||||
const current = ElectricCurrent.Of(f32).splat(2); // 2 A
|
const current = ElectricCurrent.Of(f32){ .value = 2.0 }; // 2 A
|
||||||
const time = Second.Of(f32).splat(3.0); // 3 s
|
const time = Second.Of(f32){ .value = 3.0 }; // 3 s
|
||||||
|
|
||||||
// Charge = Current * time
|
// Charge = Current * time
|
||||||
const charge = current.mul(time);
|
const charge = current.mulBy(time);
|
||||||
try std.testing.expectEqual(6.0, charge.data[0]);
|
try std.testing.expectEqual(6.0, charge.value);
|
||||||
try comptime std.testing.expect(ElectricCharge.dims.eql(@TypeOf(charge).dims));
|
try std.testing.expect(ElectricCharge.dims.eql(@TypeOf(charge).dims));
|
||||||
}
|
|
||||||
|
|
||||||
test "Constants - Initialization and dimension checks" {
|
|
||||||
// Speed of Light
|
|
||||||
const c = Constants.SpeedOfLight.Of(f64);
|
|
||||||
try std.testing.expectEqual(299792458.0, c.data[0]);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(c).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(-1, @TypeOf(c).dims.get(.T));
|
|
||||||
|
|
||||||
// Electron Mass (verifying scale as well)
|
|
||||||
const me = Constants.ElectronMass.Of(f64);
|
|
||||||
try std.testing.expectEqual(9.1093837139e-31, me.data[0]);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(me).dims.get(.M));
|
|
||||||
try std.testing.expectEqual(.k, @TypeOf(me).scales.get(.M)); // Should be scaled to kg
|
|
||||||
|
|
||||||
// Boltzmann Constant (Complex derived dimensions)
|
|
||||||
const kb = Constants.Boltzmann.Of(f64);
|
|
||||||
try std.testing.expectEqual(1.380649e-23, kb.data[0]);
|
|
||||||
try std.testing.expectEqual(1, @TypeOf(kb).dims.get(.M));
|
|
||||||
try std.testing.expectEqual(2, @TypeOf(kb).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(-2, @TypeOf(kb).dims.get(.T));
|
|
||||||
try std.testing.expectEqual(-1, @TypeOf(kb).dims.get(.Tp));
|
|
||||||
try std.testing.expectEqual(.k, @TypeOf(kb).scales.get(.M));
|
|
||||||
|
|
||||||
// Vacuum Permittivity
|
|
||||||
const eps0 = Constants.VacuumPermittivity.Of(f64);
|
|
||||||
try std.testing.expectEqual(8.8541878188e-12, eps0.data[0]);
|
|
||||||
try std.testing.expectEqual(-1, @TypeOf(eps0).dims.get(.M));
|
|
||||||
try std.testing.expectEqual(-3, @TypeOf(eps0).dims.get(.L));
|
|
||||||
try std.testing.expectEqual(4, @TypeOf(eps0).dims.get(.T));
|
|
||||||
try std.testing.expectEqual(2, @TypeOf(eps0).dims.get(.I));
|
|
||||||
|
|
||||||
// Fine Structure Constant (Dimensionless)
|
|
||||||
const alpha = Constants.FineStructure.Of(f64);
|
|
||||||
try std.testing.expectEqual(0.0072973525643, alpha.data[0]);
|
|
||||||
try std.testing.expectEqual(0, @TypeOf(alpha).dims.get(.M));
|
|
||||||
try std.testing.expectEqual(0, @TypeOf(alpha).dims.get(.L));
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,15 +1,5 @@
|
|||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
|
|
||||||
pub const ArgOpts = struct {
|
|
||||||
L: comptime_int = 0,
|
|
||||||
M: comptime_int = 0,
|
|
||||||
T: comptime_int = 0,
|
|
||||||
I: comptime_int = 0,
|
|
||||||
Tp: comptime_int = 0,
|
|
||||||
N: comptime_int = 0,
|
|
||||||
J: comptime_int = 0,
|
|
||||||
};
|
|
||||||
|
|
||||||
pub const Dimension = enum {
|
pub const Dimension = enum {
|
||||||
/// Length
|
/// Length
|
||||||
L,
|
L,
|
||||||
@ -41,89 +31,55 @@ pub const Dimension = enum {
|
|||||||
|
|
||||||
// --------- Dimensions struct ---------
|
// --------- Dimensions struct ---------
|
||||||
|
|
||||||
/// Holds the exponent of each SI base dimension for a given quantity (e.g. velocity = L¹T⁻¹).
|
|
||||||
/// All values are `comptime_int` — no runtime storage.
|
|
||||||
const Self = @This();
|
const Self = @This();
|
||||||
|
|
||||||
data: std.EnumArray(Dimension, comptime_int),
|
data: std.EnumArray(Dimension, comptime_int),
|
||||||
|
|
||||||
/// Create a `Dimensions` from a struct literal, e.g. `.{ .L = 1, .T = -1 }`.
|
pub fn init(comptime init_val: anytype) Self {
|
||||||
/// Unspecified dimensions default to 0.
|
|
||||||
pub fn init(init_val: ArgOpts) Self {
|
|
||||||
var s = Self{ .data = std.EnumArray(Dimension, comptime_int).initFill(0) };
|
var s = Self{ .data = std.EnumArray(Dimension, comptime_int).initFill(0) };
|
||||||
for (std.meta.fields(@TypeOf(init_val))) |f|
|
inline for (std.meta.fields(@TypeOf(init_val))) |f|
|
||||||
s.data.set(@field(Dimension, f.name), @field(init_val, f.name));
|
s.data.set(@field(Dimension, f.name), @field(init_val, f.name));
|
||||||
return s;
|
return s;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn initFill(val: comptime_int) Self {
|
pub fn initFill(comptime val: comptime_int) Self {
|
||||||
return .{ .data = std.EnumArray(Dimension, comptime_int).initFill(val) };
|
return .{ .data = std.EnumArray(Dimension, comptime_int).initFill(val) };
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get(self: Self, key: Dimension) comptime_int {
|
pub fn get(comptime self: Self, comptime key: Dimension) comptime_int {
|
||||||
return self.data.get(key);
|
return self.data.get(key);
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn set(self: *Self, key: Dimension, val: i8) void {
|
pub fn set(comptime self: *Self, comptime key: Dimension, comptime val: i8) void {
|
||||||
self.data.set(key, val);
|
self.data.set(key, val);
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn argsOpt(self: Self) ArgOpts {
|
pub fn add(comptime a: Self, comptime b: Self) Self {
|
||||||
var args: ArgOpts = undefined;
|
|
||||||
for (std.enums.values(Dimension)) |d|
|
|
||||||
@field(args, @tagName(d)) = self.get(d);
|
|
||||||
return args;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Add exponents component-wise. Used internally by `mul`.
|
|
||||||
pub fn add(a: Self, b: Self) Self {
|
|
||||||
var result = Self.initFill(0);
|
var result = Self.initFill(0);
|
||||||
for (std.enums.values(Dimension)) |d|
|
for (std.enums.values(Dimension)) |d|
|
||||||
result.set(d, a.get(d) + b.get(d));
|
result.set(d, a.get(d) + b.get(d));
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Subtract exponents component-wise. Used internally by `div`.
|
pub fn sub(comptime a: Self, comptime b: Self) Self {
|
||||||
pub fn sub(a: Self, b: Self) Self {
|
@setEvalBranchQuota(10_000);
|
||||||
var result = Self.initFill(0);
|
var result = Self.initFill(0);
|
||||||
for (std.enums.values(Dimension)) |d|
|
inline for (std.enums.values(Dimension)) |d|
|
||||||
result.set(d, a.get(d) - b.get(d));
|
result.set(d, a.get(d) - b.get(d));
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Multiply exponents by a scalar integer. Used internally by `pow` in Scalar.
|
pub fn eql(comptime a: Self, comptime b: Self) bool {
|
||||||
pub fn scale(a: Self, exp: comptime_int) Self {
|
inline for (std.enums.values(Dimension)) |d|
|
||||||
var result = Self.initFill(0);
|
|
||||||
for (std.enums.values(Dimension)) |d|
|
|
||||||
result.set(d, a.get(d) * exp);
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn div(a: Self, exp: comptime_int) Self {
|
|
||||||
var result = Self.initFill(0);
|
|
||||||
for (std.enums.values(Dimension)) |d|
|
|
||||||
result.set(d, a.get(d) / exp);
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns true if every dimension exponent is equal. Used to enforce type compatibility in `add`, `sub`, `to`.
|
|
||||||
pub fn eql(a: Self, b: Self) bool {
|
|
||||||
for (std.enums.values(Dimension)) |d|
|
|
||||||
if (a.get(d) != b.get(d)) return false;
|
if (a.get(d) != b.get(d)) return false;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn isSquare(a: Self) bool {
|
pub fn str(comptime a: Self) []const u8 {
|
||||||
for (std.enums.values(Dimension)) |d|
|
|
||||||
if (a.get(d) % 2 != 0) return false;
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn str(a: Self) []const u8 {
|
|
||||||
var out: []const u8 = "";
|
var out: []const u8 = "";
|
||||||
const dims = std.enums.values(Dimension);
|
const dims = std.enums.values(Dimension);
|
||||||
|
|
||||||
for (dims) |d| {
|
inline for (dims) |d| {
|
||||||
const val = a.get(d);
|
const val = a.get(d);
|
||||||
if (val != 0) {
|
if (val != 0) {
|
||||||
out = out ++ @tagName(d) ++ std.fmt.comptimePrint("{d}", .{val});
|
out = out ++ @tagName(d) ++ std.fmt.comptimePrint("{d}", .{val});
|
||||||
|
|||||||
396
src/Scalar.zig
Normal file
396
src/Scalar.zig
Normal file
@ -0,0 +1,396 @@
|
|||||||
|
const std = @import("std");
|
||||||
|
const hlp = @import("helper.zig");
|
||||||
|
|
||||||
|
const Vector = @import("Vector.zig").Vector;
|
||||||
|
const Scales = @import("Scales.zig");
|
||||||
|
const UnitScale = Scales.UnitScale;
|
||||||
|
const Dimensions = @import("Dimensions.zig");
|
||||||
|
const Dimension = Dimensions.Dimension;
|
||||||
|
|
||||||
|
pub fn Scalar(comptime T: type, comptime d: Dimensions, comptime s: Scales) type {
|
||||||
|
@setEvalBranchQuota(10_000_000);
|
||||||
|
return struct {
|
||||||
|
value: T,
|
||||||
|
|
||||||
|
const Self = @This();
|
||||||
|
pub const Vec3: type = Vector(3, Self);
|
||||||
|
pub const ValueType: type = T;
|
||||||
|
|
||||||
|
pub const dims: Dimensions = d;
|
||||||
|
pub const scales = s;
|
||||||
|
|
||||||
|
pub inline fn add(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims,
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
if (comptime !dims.eql(@TypeOf(rhs).dims))
|
||||||
|
@compileError("Dimension mismatch in add: " ++ dims.str() ++ " vs " ++ @TypeOf(rhs).dims.str());
|
||||||
|
if (comptime @TypeOf(rhs) == Self)
|
||||||
|
return .{ .value = self.value + rhs.value };
|
||||||
|
|
||||||
|
const TargetType = Scalar(T, dims, scales.min(@TypeOf(rhs).scales));
|
||||||
|
const lhs_val = if (comptime @TypeOf(self) == TargetType) self.value else self.to(TargetType).value;
|
||||||
|
const rhs_val = if (comptime @TypeOf(rhs) == TargetType) rhs.value else rhs.to(TargetType).value;
|
||||||
|
|
||||||
|
return .{ .value = lhs_val + rhs_val };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn sub(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims,
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
if (comptime !dims.eql(@TypeOf(rhs).dims))
|
||||||
|
@compileError("Dimension mismatch in sub: " ++ dims.str() ++ " vs " ++ @TypeOf(rhs).dims.str());
|
||||||
|
if (comptime @TypeOf(rhs) == Self)
|
||||||
|
return .{ .value = self.value - rhs.value };
|
||||||
|
|
||||||
|
const TargetType = Scalar(T, dims, scales.min(@TypeOf(rhs).scales));
|
||||||
|
const lhs_val = if (comptime @TypeOf(self) == TargetType) self.value else self.to(TargetType).value;
|
||||||
|
const rhs_val = if (comptime @TypeOf(rhs) == TargetType) rhs.value else rhs.to(TargetType).value;
|
||||||
|
|
||||||
|
return .{ .value = lhs_val - rhs_val };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn mulBy(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims.add(@TypeOf(rhs).dims),
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
const RhsType = @TypeOf(rhs);
|
||||||
|
const SelfNorm = Scalar(T, dims, scales.min(RhsType.scales));
|
||||||
|
const RhsNorm = Scalar(T, RhsType.dims, scales.min(RhsType.scales));
|
||||||
|
if (comptime Self == SelfNorm and RhsType == RhsNorm)
|
||||||
|
return .{ .value = self.value * rhs.value };
|
||||||
|
|
||||||
|
const lhs_val = if (comptime Self == SelfNorm) self.value else self.to(SelfNorm).value;
|
||||||
|
const rhs_val = if (comptime RhsType == RhsNorm) rhs.value else rhs.to(RhsNorm).value;
|
||||||
|
return .{ .value = lhs_val * rhs_val };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn divBy(self: Self, rhs: anytype) Scalar(
|
||||||
|
T,
|
||||||
|
dims.sub(@TypeOf(rhs).dims),
|
||||||
|
scales.min(@TypeOf(rhs).scales),
|
||||||
|
) {
|
||||||
|
const RhsType = @TypeOf(rhs);
|
||||||
|
const SelfNorm = Scalar(T, dims, scales.min(RhsType.scales));
|
||||||
|
const RhsNorm = Scalar(T, RhsType.dims, scales.min(RhsType.scales));
|
||||||
|
const lhs_val = if (comptime Self == SelfNorm) self.value else self.to(SelfNorm).value;
|
||||||
|
const rhs_val = if (comptime RhsType == RhsNorm) rhs.value else rhs.to(RhsNorm).value;
|
||||||
|
if (comptime @typeInfo(T) == .int) {
|
||||||
|
return .{ .value = @divTrunc(lhs_val, rhs_val) };
|
||||||
|
} else {
|
||||||
|
return .{ .value = lhs_val / rhs_val };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn to(self: Self, comptime Dest: type) Dest {
|
||||||
|
if (comptime !dims.eql(Dest.dims))
|
||||||
|
@compileError("Dimension mismatch in to: " ++ dims.str() ++ " vs " ++ Dest.dims.str());
|
||||||
|
if (comptime @TypeOf(self) == Dest)
|
||||||
|
return self;
|
||||||
|
|
||||||
|
const DestT = Dest.ValueType;
|
||||||
|
const ratio = comptime (scales.getFactor(dims) / Dest.scales.getFactor(Dest.dims));
|
||||||
|
|
||||||
|
// Fast-path: Native pure-integer exact conversions
|
||||||
|
if (comptime @typeInfo(T) == .int and @typeInfo(DestT) == .int) {
|
||||||
|
if (comptime ratio >= 1.0 and @round(ratio) == ratio) {
|
||||||
|
const mult: DestT = comptime @intFromFloat(ratio);
|
||||||
|
return .{ .value = @as(DestT, @intCast(self.value)) * mult };
|
||||||
|
} else if (comptime ratio < 1.0 and @round(1.0 / ratio) == 1.0 / ratio) {
|
||||||
|
const div: DestT = comptime @intFromFloat(1.0 / ratio);
|
||||||
|
const val = @as(DestT, @intCast(self.value));
|
||||||
|
const half = comptime div / 2;
|
||||||
|
// Native round-to-nearest
|
||||||
|
const rounded = if (val >= 0) @divTrunc(val + half, div) else @divTrunc(val - half, div);
|
||||||
|
return .{ .value = rounded };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback preserving native Float types (e.g., f128 shouldn't downcast to f64)
|
||||||
|
if (comptime @typeInfo(DestT) == .float) {
|
||||||
|
const val_f = switch (@typeInfo(T)) {
|
||||||
|
inline .int => @as(DestT, @floatFromInt(self.value)),
|
||||||
|
inline .float => @as(DestT, @floatCast(self.value)),
|
||||||
|
else => unreachable,
|
||||||
|
};
|
||||||
|
return .{ .value = val_f * @as(DestT, @floatCast(ratio)) };
|
||||||
|
} else {
|
||||||
|
const val_f = switch (@typeInfo(T)) {
|
||||||
|
inline .int => @as(f64, @floatFromInt(self.value)),
|
||||||
|
inline .float => @as(f64, @floatCast(self.value)),
|
||||||
|
else => unreachable,
|
||||||
|
};
|
||||||
|
return .{ .value = @intFromFloat(@round(val_f * ratio)) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn Vec(self: Self, comptime len: comptime_int) Vector(len, Self) {
|
||||||
|
return Vector(len, Self).initDefault(self.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn vec3(self: Self) Vec3 {
|
||||||
|
return Vec3.initDefault(self.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn formatNumber(
|
||||||
|
self: Self,
|
||||||
|
writer: *std.Io.Writer,
|
||||||
|
options: std.fmt.Number,
|
||||||
|
) !void {
|
||||||
|
switch (@typeInfo(T)) {
|
||||||
|
.float, .comptime_float => try writer.printFloat(self.value, options),
|
||||||
|
.int, .comptime_int => try writer.printInt(self.value, 10, .lower, .{
|
||||||
|
.width = options.width,
|
||||||
|
.alignment = options.alignment,
|
||||||
|
.fill = options.fill,
|
||||||
|
.precision = options.precision,
|
||||||
|
}),
|
||||||
|
else => unreachable,
|
||||||
|
}
|
||||||
|
var first = true;
|
||||||
|
inline for (std.enums.values(Dimension)) |bu| {
|
||||||
|
const v = dims.get(bu);
|
||||||
|
if (comptime v == 0) continue;
|
||||||
|
if (!first)
|
||||||
|
try writer.writeAll(".");
|
||||||
|
|
||||||
|
first = false;
|
||||||
|
|
||||||
|
const uscale = scales.get(bu);
|
||||||
|
if (bu == .T and (uscale == .min or uscale == .hour or uscale == .year))
|
||||||
|
try writer.print("{s}", .{uscale.str()})
|
||||||
|
else
|
||||||
|
try writer.print("{s}{s}", .{ uscale.str(), bu.unit() });
|
||||||
|
|
||||||
|
if (v != 1)
|
||||||
|
try hlp.printSuperscript(writer, v);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Generate quantity" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = -3 }));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .n }));
|
||||||
|
|
||||||
|
const distance = Meter{ .value = 10 };
|
||||||
|
const time = Second{ .value = 2 };
|
||||||
|
|
||||||
|
try std.testing.expectEqual(10, distance.value);
|
||||||
|
try std.testing.expectEqual(2, time.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Add" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const distance = Meter{ .value = 10 };
|
||||||
|
const distance2 = Meter{ .value = 20 };
|
||||||
|
|
||||||
|
const added = distance.add(distance2);
|
||||||
|
try std.testing.expectEqual(30, added.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added).dims.get(.L));
|
||||||
|
|
||||||
|
const KiloMeter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const distance3 = KiloMeter{ .value = 2 };
|
||||||
|
const added2 = distance.add(distance3);
|
||||||
|
try std.testing.expectEqual(2010, added2.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added2).dims.get(.L));
|
||||||
|
|
||||||
|
const added3 = distance3.add(distance).to(KiloMeter);
|
||||||
|
try std.testing.expectEqual(2, added3.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added3).dims.get(.L));
|
||||||
|
|
||||||
|
const KiloMeter_f = Scalar(f64, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const distance4 = KiloMeter_f{ .value = 2 };
|
||||||
|
const added4 = distance4.add(distance).to(KiloMeter_f);
|
||||||
|
try std.testing.expectApproxEqAbs(2.01, added4.value, 0.000001);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(added4).dims.get(.L));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Sub" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const KiloMeter_f = Scalar(f64, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
|
||||||
|
const a = Meter{ .value = 500 };
|
||||||
|
const b = Meter{ .value = 200 };
|
||||||
|
const diff = a.sub(b);
|
||||||
|
try std.testing.expectEqual(300, diff.value);
|
||||||
|
const diff2 = b.sub(a);
|
||||||
|
try std.testing.expectEqual(-300, diff2.value);
|
||||||
|
|
||||||
|
const km_f = KiloMeter_f{ .value = 2.5 };
|
||||||
|
const m_f = Meter{ .value = 500 };
|
||||||
|
const diff3 = km_f.sub(m_f);
|
||||||
|
try std.testing.expectApproxEqAbs(2000, diff3.value, 1e-4);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 3.0 };
|
||||||
|
const t = Second{ .value = 4.0 };
|
||||||
|
|
||||||
|
const area_time = d.mulBy(t);
|
||||||
|
try std.testing.expectEqual(12, area_time.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
||||||
|
|
||||||
|
const d2 = Meter{ .value = 5.0 };
|
||||||
|
const area = d.mulBy(d2);
|
||||||
|
try std.testing.expectEqual(15, area.value);
|
||||||
|
try std.testing.expectEqual(2, @TypeOf(area).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(0, @TypeOf(area).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy with scale" {
|
||||||
|
const KiloMeter = Scalar(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const KiloGram = Scalar(f32, Dimensions.init(.{ .M = 1 }), Scales.init(.{ .M = .k }));
|
||||||
|
|
||||||
|
const dist = KiloMeter{ .value = 2.0 };
|
||||||
|
const mass = KiloGram{ .value = 3.0 };
|
||||||
|
const prod = dist.mulBy(mass);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(prod).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(prod).dims.get(.M));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy with type change" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const Second = Scalar(f64, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
const KmSec = Scalar(i64, Dimensions.init(.{ .L = 1, .T = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const KmSec_f = Scalar(f32, Dimensions.init(.{ .L = 1, .T = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 3.0 };
|
||||||
|
const t = Second{ .value = 4.0 };
|
||||||
|
|
||||||
|
const area_time = d.mulBy(t).to(KmSec);
|
||||||
|
const area_time_f = d.mulBy(t).to(KmSec_f);
|
||||||
|
try std.testing.expectEqual(12, area_time.value);
|
||||||
|
try std.testing.expectApproxEqAbs(12, area_time_f.value, 0.0001);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy small" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .n }));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 3.0 };
|
||||||
|
const t = Second{ .value = 4.0 };
|
||||||
|
|
||||||
|
const area_time = d.mulBy(t);
|
||||||
|
try std.testing.expectEqual(12, area_time.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(area_time).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "MulBy dimensionless" {
|
||||||
|
const DimLess = Scalar(i128, Dimensions.init(.{}), Scales.init(.{}));
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const d = Meter{ .value = 7 };
|
||||||
|
const scaled = d.mulBy(DimLess{ .value = 3 });
|
||||||
|
try std.testing.expectEqual(21, scaled.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(scaled).dims.get(.L));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Chained: velocity and acceleration" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const dist = Meter{ .value = 100.0 };
|
||||||
|
const t1 = Second{ .value = 5.0 };
|
||||||
|
const velocity = dist.divBy(t1);
|
||||||
|
try std.testing.expectEqual(20, velocity.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(velocity).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-1, @TypeOf(velocity).dims.get(.T));
|
||||||
|
|
||||||
|
const t2 = Second{ .value = 4.0 };
|
||||||
|
const accel = velocity.divBy(t2);
|
||||||
|
try std.testing.expectEqual(5, accel.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(accel).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-2, @TypeOf(accel).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "DivBy integer exact" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(f32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const dist = Meter{ .value = 120 };
|
||||||
|
const time = Second{ .value = 4 };
|
||||||
|
const vel = dist.divBy(time);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(30, vel.value);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(vel).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-1, @TypeOf(vel).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Conversion chain: km -> m -> cm" {
|
||||||
|
const KiloMeter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const CentiMeter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .c }));
|
||||||
|
|
||||||
|
const km = KiloMeter{ .value = 15 };
|
||||||
|
const m = km.to(Meter);
|
||||||
|
const cm = m.to(CentiMeter);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(15_000, m.value);
|
||||||
|
try std.testing.expectEqual(1_500_000, cm.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Conversion: hours -> minutes -> seconds" {
|
||||||
|
const Hour = Scalar(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .hour }));
|
||||||
|
const Minute = Scalar(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{ .T = .min }));
|
||||||
|
const Second = Scalar(i128, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const h = Hour{ .value = 1.0 };
|
||||||
|
const min = h.to(Minute);
|
||||||
|
const sec = min.to(Second);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(60, min.value);
|
||||||
|
try std.testing.expectEqual(3600, sec.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Negative values" {
|
||||||
|
const Meter = Scalar(i128, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const a = Meter{ .value = 5 };
|
||||||
|
const b = Meter{ .value = 20 };
|
||||||
|
const diff = a.sub(b);
|
||||||
|
try std.testing.expectEqual(-15, diff.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Format Scalar" {
|
||||||
|
const MeterPerSecondSq = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .L = 1, .T = -2 }),
|
||||||
|
Scales.init(.{ .T = .n }),
|
||||||
|
);
|
||||||
|
const KgMeterPerSecond = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .M = 1, .L = 1, .T = -1 }),
|
||||||
|
Scales.init(.{ .M = .k }),
|
||||||
|
);
|
||||||
|
const Meter = Scalar(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const m = Meter{ .value = 1.23456 };
|
||||||
|
const accel = MeterPerSecondSq{ .value = 9.81 };
|
||||||
|
const momentum = KgMeterPerSecond{ .value = 42.0 };
|
||||||
|
|
||||||
|
var buf: [64]u8 = undefined;
|
||||||
|
var res = try std.fmt.bufPrint(&buf, "{d:.2}", .{m});
|
||||||
|
try std.testing.expectEqualStrings("1.23m", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d}", .{accel});
|
||||||
|
try std.testing.expectEqualStrings("9.81m.ns⁻²", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d}", .{momentum});
|
||||||
|
try std.testing.expectEqualStrings("42m.kg.s⁻¹", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d:_>10.1}", .{m});
|
||||||
|
try std.testing.expectEqualStrings("_______1.2m", res);
|
||||||
|
}
|
||||||
118
src/Scales.zig
118
src/Scales.zig
@ -1,23 +1,8 @@
|
|||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
|
const hlp = @import("helper.zig");
|
||||||
const Dimensions = @import("Dimensions.zig");
|
const Dimensions = @import("Dimensions.zig");
|
||||||
const Dimension = @import("Dimensions.zig").Dimension;
|
const Dimension = @import("Dimensions.zig").Dimension;
|
||||||
|
|
||||||
// TODO: add more scales like feet and inch
|
|
||||||
|
|
||||||
/// Use to initiate Scalar and Scales type
|
|
||||||
pub const ArgOpts = struct {
|
|
||||||
L: UnitScale = .none,
|
|
||||||
M: UnitScale = .none,
|
|
||||||
T: UnitScale = .none,
|
|
||||||
I: UnitScale = .none,
|
|
||||||
Tp: UnitScale = .none,
|
|
||||||
N: UnitScale = .none,
|
|
||||||
J: UnitScale = .none,
|
|
||||||
};
|
|
||||||
|
|
||||||
/// SI prefix (pico…peta) plus time-unit aliases (min, hour, year).
|
|
||||||
/// The integer value encodes the exponent for SI prefixes (e.g. `k = 3` → 10³),
|
|
||||||
/// and the literal factor for time units (e.g. `hour = 3600`).
|
|
||||||
pub const UnitScale = enum(isize) {
|
pub const UnitScale = enum(isize) {
|
||||||
P = 15,
|
P = 15,
|
||||||
T = 12,
|
T = 12,
|
||||||
@ -40,108 +25,79 @@ pub const UnitScale = enum(isize) {
|
|||||||
hour = 3_600,
|
hour = 3_600,
|
||||||
year = 31_536_000,
|
year = 31_536_000,
|
||||||
|
|
||||||
// Imperial Length (Literal factors in meters)
|
|
||||||
// 1 inch = 0.0254 meters. Since enum backing is isize,
|
|
||||||
// we use a unique tag and handle the float in getFactor.
|
|
||||||
inch = -1001,
|
|
||||||
ft = -1002,
|
|
||||||
yd = -1003,
|
|
||||||
mi = -1004,
|
|
||||||
|
|
||||||
oz = -1005, // 1 oz = 28.3495231 g
|
|
||||||
lb = -1006, // 1 lb = 453.59237 g (= 16 oz)
|
|
||||||
st = -1007, // 1 stone = 6350.29318 g (= 14 lb)
|
|
||||||
|
|
||||||
// Undefined
|
// Undefined
|
||||||
_,
|
_,
|
||||||
|
|
||||||
pub fn str(self: @This()) []const u8 {
|
pub inline fn str(self: @This()) []const u8 {
|
||||||
var buf: [16]u8 = undefined;
|
var buf: [16]u8 = undefined;
|
||||||
return switch (self) {
|
return switch (self) {
|
||||||
.none => "",
|
inline .none => "",
|
||||||
.P, .T, .G, .M, .k, .h, .da, .d, .c, .m, .u, .n, .p, .f, .min, .hour, .year, .inch, .ft, .yd, .mi, .oz, .lb, .st => @tagName(self),
|
inline .P, .T, .G, .M, .k, .h, .da, .d, .c, .m, .u, .n, .p, .f, .min, .hour, .year => @tagName(self),
|
||||||
else => std.fmt.bufPrint(&buf, "[{d}]", .{@intFromEnum(self)}) catch "[]", // This cannot be inline because of non exhaustive enum, but that's ok, it is just str, not calculation
|
else => std.fmt.bufPrint(&buf, "[{d}]", .{@intFromEnum(self)}) catch "[]", // This cannot be inline because of non exhaustive enum, but that's ok, it is just str, not calculation
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn getFactor(self: @This()) comptime_float {
|
/// Helper to get the actual scaling factor
|
||||||
|
pub inline fn getFactor(self: @This()) comptime_float {
|
||||||
return switch (self) {
|
return switch (self) {
|
||||||
// Standard SI Exponents
|
inline .P, .T, .G, .M, .k, .h, .da, .none, .d, .c, .m, .u, .n, .p, .f => std.math.pow(f64, 10.0, @floatFromInt(@intFromEnum(self))),
|
||||||
.P, .T, .G, .M, .k, .h, .da, .none, .d, .c, .m, .u, .n, .p, .f => std.math.pow(f64, 10.0, @floatFromInt(@intFromEnum(self))),
|
inline else => @floatFromInt(@intFromEnum(self)),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
// Time Factors
|
/// Helper to get the actual scaling factor in i32
|
||||||
.min, .hour, .year => @floatFromInt(@intFromEnum(self)),
|
pub inline fn getFactorInt(self: @This()) comptime_int {
|
||||||
|
return switch (self) {
|
||||||
// Imperial Length (metres)
|
inline .P, .T, .G, .M, .k, .h, .da, .none, .d, .c, .m, .u, .n, .p, .f => comptime std.math.powi(i32, 10.0, @intFromEnum(self)) catch 0,
|
||||||
.inch => 0.0254,
|
inline else => comptime @intFromEnum(self),
|
||||||
.ft => 0.3048,
|
|
||||||
.yd => 0.9144,
|
|
||||||
.mi => 1609.344,
|
|
||||||
|
|
||||||
// Imperial Mass (grams — base unit for M is gram, i.e. .none = 1 g)
|
|
||||||
.oz => 28.3495231,
|
|
||||||
.lb => 453.59237,
|
|
||||||
.st => 6350.29318,
|
|
||||||
|
|
||||||
else => @floatFromInt(@intFromEnum(self)),
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Maps each SI base dimension to its `UnitScale`. Stored and resolved entirely at comptime.
|
const Scales = @This();
|
||||||
const Self = @This();
|
|
||||||
|
|
||||||
data: std.EnumArray(Dimension, UnitScale),
|
data: std.EnumArray(Dimension, UnitScale),
|
||||||
|
|
||||||
/// Create a `Scales` from a struct literal, e.g. `.{ .L = .k, .T = .hour }`.
|
pub fn init(comptime init_val: anytype) Scales {
|
||||||
/// Unspecified dimensions default to `.none` (factor 1).
|
comptime var s = Scales{ .data = std.EnumArray(Dimension, UnitScale).initFill(.none) };
|
||||||
pub fn init(comptime init_val: ArgOpts) Self {
|
inline for (std.meta.fields(@TypeOf(init_val))) |f| {
|
||||||
comptime var s = Self{ .data = std.EnumArray(Dimension, UnitScale).initFill(.none) };
|
if (comptime hlp.isInt(@TypeOf(@field(init_val, f.name))))
|
||||||
for (std.meta.fields(@TypeOf(init_val))) |f| {
|
|
||||||
if (comptime @typeInfo(@TypeOf(@field(init_val, f.name))) == .comptime_int)
|
|
||||||
s.data.set(@field(Dimension, f.name), @enumFromInt(@field(init_val, f.name)))
|
s.data.set(@field(Dimension, f.name), @enumFromInt(@field(init_val, f.name)))
|
||||||
else
|
else
|
||||||
s.data.set(@field(Dimension, f.name), @field(init_val, f.name));
|
s.data.set(@field(Dimension, f.name), @field(init_val, f.name));
|
||||||
}
|
}
|
||||||
return comptime s;
|
return s;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn initFill(val: UnitScale) Self {
|
pub fn initFill(comptime val: UnitScale) Scales {
|
||||||
return .{ .data = std.EnumArray(Dimension, UnitScale).initFill(val) };
|
return comptime .{ .data = std.EnumArray(Dimension, UnitScale).initFill(val) };
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get(self: Self, key: Dimension) UnitScale {
|
pub fn get(comptime self: Scales, comptime key: Dimension) UnitScale {
|
||||||
return self.data.get(key);
|
return comptime self.data.get(key);
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn set(self: *Self, key: Dimension, val: UnitScale) void {
|
pub fn set(comptime self: *Scales, comptime key: Dimension, comptime val: UnitScale) void {
|
||||||
self.data.set(key, val);
|
comptime self.data.set(key, val);
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn eql(self: Self, other: Self) bool {
|
pub fn min(comptime s1: Scales, comptime s2: Scales) Scales {
|
||||||
for (self.data.values, other.data.values) |l, r|
|
comptime var out = Scales.initFill(.none);
|
||||||
if (l != r) return false;
|
inline for (std.enums.values(Dimension)) |dim|
|
||||||
return true;
|
out.set(dim, if (s1.get(dim).getFactorInt() > s2.get(dim).getFactorInt()) s2.get(dim) else s1.get(dim));
|
||||||
|
|
||||||
|
return out;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn argsOpt(self: Self) ArgOpts {
|
pub inline fn getFactor(comptime s: Scales, comptime d: Dimensions) comptime_float {
|
||||||
var args: ArgOpts = undefined;
|
comptime var factor: f64 = 1.0;
|
||||||
for (std.enums.values(Dimension)) |d|
|
inline for (std.enums.values(Dimension)) |dim| {
|
||||||
@field(args, @tagName(d)) = self.get(d);
|
|
||||||
return args;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Compute the combined scale factor for a given dimension signature.
|
|
||||||
/// Each dimension's prefix is raised to its exponent and multiplied together.
|
|
||||||
pub fn getFactor(s: Self, d: Dimensions) comptime_float {
|
|
||||||
var factor: f64 = 1.0;
|
|
||||||
for (std.enums.values(Dimension)) |dim| {
|
|
||||||
const power = d.get(dim);
|
const power = d.get(dim);
|
||||||
if (power == 0) continue;
|
if (power == 0) continue;
|
||||||
|
|
||||||
const base = s.get(dim).getFactor();
|
const base = s.get(dim).getFactor();
|
||||||
|
|
||||||
var i: comptime_int = 0;
|
var i: i32 = 0;
|
||||||
const abs_power = if (power < 0) -power else power;
|
const abs_power = if (power < 0) -power else power;
|
||||||
while (i < abs_power) : (i += 1) {
|
while (i < abs_power) : (i += 1) {
|
||||||
if (power > 0)
|
if (power > 0)
|
||||||
|
|||||||
1395
src/Tensor.zig
1395
src/Tensor.zig
File diff suppressed because it is too large
Load Diff
318
src/Vector.zig
Normal file
318
src/Vector.zig
Normal file
@ -0,0 +1,318 @@
|
|||||||
|
const std = @import("std");
|
||||||
|
const hlp = @import("helper.zig");
|
||||||
|
|
||||||
|
const Scalar = @import("Scalar.zig").Scalar;
|
||||||
|
const Scales = @import("Scales.zig");
|
||||||
|
const UnitScale = Scales.UnitScale;
|
||||||
|
const Dimensions = @import("Dimensions.zig");
|
||||||
|
const Dimension = Dimensions.Dimension;
|
||||||
|
|
||||||
|
pub fn Vector(comptime len: usize, comptime Q: type) type {
|
||||||
|
const T = Q.ValueType;
|
||||||
|
const d: Dimensions = Q.dims;
|
||||||
|
const s: Scales = Q.scales;
|
||||||
|
|
||||||
|
return struct {
|
||||||
|
data: [len]T,
|
||||||
|
|
||||||
|
const Self = @This();
|
||||||
|
pub const ScalarType = Q;
|
||||||
|
pub const ValueType = T;
|
||||||
|
pub const dims: Dimensions = d;
|
||||||
|
pub const scales = s;
|
||||||
|
|
||||||
|
pub const zero = initDefault(0);
|
||||||
|
pub const one = initDefault(1);
|
||||||
|
|
||||||
|
pub fn initDefault(v: T) Self {
|
||||||
|
var data: [len]T = undefined;
|
||||||
|
inline for (&data) |*item| item.* = v;
|
||||||
|
return .{ .data = data };
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn add(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).add(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn sub(self: Self, rhs: anytype) Vector(len, Scalar(T, d, s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d, s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).sub(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn divBy(
|
||||||
|
self: Self,
|
||||||
|
rhs: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.sub(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d.sub(Tr.dims), s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).divBy(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn mulBy(
|
||||||
|
self: Self,
|
||||||
|
rhs: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.add(@TypeOf(rhs).dims), s.min(@TypeOf(rhs).scales))) {
|
||||||
|
const Tr = @TypeOf(rhs);
|
||||||
|
var res: Vector(len, Scalar(T, d.add(Tr.dims), s.min(Tr.scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = (Q{ .value = v }).mulBy(Tr.ScalarType{ .value = rhs.data[i] });
|
||||||
|
res.data[i] = q.value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn divByScalar(
|
||||||
|
self: Self,
|
||||||
|
scalar: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) {
|
||||||
|
var res: Vector(len, Scalar(T, d.sub(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = Q{ .value = v };
|
||||||
|
res.data[i] = q.divBy(scalar).value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn mulByScalar(
|
||||||
|
self: Self,
|
||||||
|
scalar: anytype,
|
||||||
|
) Vector(len, Scalar(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) {
|
||||||
|
var res: Vector(len, Scalar(T, d.add(@TypeOf(scalar).dims), s.min(@TypeOf(scalar).scales))) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
const q = Q{ .value = v };
|
||||||
|
res.data[i] = q.mulBy(scalar).value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn negate(self: Self) Self {
|
||||||
|
var res: Self = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
res.data[i] = -v;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn to(self: Self, comptime DestQ: type) Vector(len, DestQ) {
|
||||||
|
var res: Vector(len, DestQ) = undefined;
|
||||||
|
inline for (self.data, 0..) |v, i| {
|
||||||
|
res.data[i] = (Q{ .value = v }).to(DestQ).value;
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn lengthSqr(self: Self) T {
|
||||||
|
var sum: T = 0;
|
||||||
|
inline for (self.data) |v| {
|
||||||
|
sum += v * v;
|
||||||
|
}
|
||||||
|
return sum;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub inline fn length(self: Self) T {
|
||||||
|
const len_sq = self.lengthSqr();
|
||||||
|
|
||||||
|
if (comptime @typeInfo(T) == .int) {
|
||||||
|
// Construct the unsigned equivalent of T at comptime (e.g., i32 -> u32)
|
||||||
|
const UnsignedT = @Int(.unsigned, @typeInfo(T).int.bits);
|
||||||
|
|
||||||
|
// len_sq is always positive, so @intCast is perfectly safe
|
||||||
|
const u_len_sq = @as(UnsignedT, @intCast(len_sq));
|
||||||
|
return @as(T, @intCast(std.math.sqrt(u_len_sq)));
|
||||||
|
} else {
|
||||||
|
return @sqrt(len_sq);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn formatNumber(
|
||||||
|
self: Self,
|
||||||
|
writer: *std.Io.Writer,
|
||||||
|
options: std.fmt.Number,
|
||||||
|
) !void {
|
||||||
|
try writer.writeAll("(");
|
||||||
|
for (self.data, 0..) |v, i| {
|
||||||
|
if (i > 0) try writer.writeAll(", ");
|
||||||
|
switch (@typeInfo(T)) {
|
||||||
|
.float, .comptime_float => try writer.printFloat(v, options),
|
||||||
|
.int, .comptime_int => try writer.printInt(v, 10, .lower, .{
|
||||||
|
.width = options.width,
|
||||||
|
.alignment = options.alignment,
|
||||||
|
.fill = options.fill,
|
||||||
|
.precision = options.precision,
|
||||||
|
}),
|
||||||
|
else => unreachable,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
try writer.writeAll(")");
|
||||||
|
var first = true;
|
||||||
|
inline for (std.enums.values(Dimension)) |bu| {
|
||||||
|
const v = dims.get(bu);
|
||||||
|
if (comptime v == 0) continue;
|
||||||
|
if (!first)
|
||||||
|
try writer.writeAll(".");
|
||||||
|
|
||||||
|
first = false;
|
||||||
|
|
||||||
|
const uscale = scales.get(bu);
|
||||||
|
if (bu == .T and (uscale == .min or uscale == .hour or uscale == .year))
|
||||||
|
try writer.print("{s}", .{uscale.str()})
|
||||||
|
else
|
||||||
|
try writer.print("{s}{s}", .{ uscale.str(), bu.unit() });
|
||||||
|
|
||||||
|
if (v != 1)
|
||||||
|
try hlp.printSuperscript(writer, v);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
test "Format VectorX" {
|
||||||
|
const MeterPerSecondSq = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .L = 1, .T = -2 }),
|
||||||
|
Scales.init(.{ .T = .n }),
|
||||||
|
);
|
||||||
|
const KgMeterPerSecond = Scalar(
|
||||||
|
f32,
|
||||||
|
Dimensions.init(.{ .M = 1, .L = 1, .T = -1 }),
|
||||||
|
Scales.init(.{ .M = .k }),
|
||||||
|
);
|
||||||
|
|
||||||
|
const accel = MeterPerSecondSq.Vec3.initDefault(9.81);
|
||||||
|
const momentum = KgMeterPerSecond.Vec3{ .data = .{ 43, 0, 11 } };
|
||||||
|
|
||||||
|
var buf: [64]u8 = undefined;
|
||||||
|
var res = try std.fmt.bufPrint(&buf, "{d}", .{accel});
|
||||||
|
try std.testing.expectEqualStrings("(9.81, 9.81, 9.81)m.ns⁻²", res);
|
||||||
|
|
||||||
|
res = try std.fmt.bufPrint(&buf, "{d:.2}", .{momentum});
|
||||||
|
try std.testing.expectEqualStrings("(43.00, 0.00, 11.00)m.kg.s⁻¹", res);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Init and Basic Arithmetic" {
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Vec3M = Meter.Vec3;
|
||||||
|
|
||||||
|
// Test zero, one, initDefault
|
||||||
|
const v_zero = Vec3M.zero;
|
||||||
|
try std.testing.expectEqual(0, v_zero.data[0]);
|
||||||
|
try std.testing.expectEqual(0, v_zero.data[1]);
|
||||||
|
try std.testing.expectEqual(0, v_zero.data[2]);
|
||||||
|
|
||||||
|
const v_one = Vec3M.one;
|
||||||
|
try std.testing.expectEqual(1, v_one.data[0]);
|
||||||
|
try std.testing.expectEqual(1, v_one.data[1]);
|
||||||
|
try std.testing.expectEqual(1, v_one.data[2]);
|
||||||
|
|
||||||
|
const v_def = Vec3M.initDefault(5);
|
||||||
|
try std.testing.expectEqual(5, v_def.data[0]);
|
||||||
|
try std.testing.expectEqual(5, v_def.data[1]);
|
||||||
|
try std.testing.expectEqual(5, v_def.data[2]);
|
||||||
|
|
||||||
|
// Test add and sub
|
||||||
|
const v1 = Vec3M{ .data = .{ 10, 20, 30 } };
|
||||||
|
const v2 = Vec3M{ .data = .{ 2, 4, 6 } };
|
||||||
|
|
||||||
|
const added = v1.add(v2);
|
||||||
|
try std.testing.expectEqual(12, added.data[0]);
|
||||||
|
try std.testing.expectEqual(24, added.data[1]);
|
||||||
|
try std.testing.expectEqual(36, added.data[2]);
|
||||||
|
|
||||||
|
const subbed = v1.sub(v2);
|
||||||
|
try std.testing.expectEqual(8, subbed.data[0]);
|
||||||
|
try std.testing.expectEqual(16, subbed.data[1]);
|
||||||
|
try std.testing.expectEqual(24, subbed.data[2]);
|
||||||
|
|
||||||
|
// Test negate
|
||||||
|
const neg = v1.negate();
|
||||||
|
try std.testing.expectEqual(-10, neg.data[0]);
|
||||||
|
try std.testing.expectEqual(-20, neg.data[1]);
|
||||||
|
try std.testing.expectEqual(-30, neg.data[2]);
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Kinematics (Scalar Mul/Div)" {
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Second = Scalar(i32, Dimensions.init(.{ .T = 1 }), Scales.init(.{}));
|
||||||
|
const Vec3M = Meter.Vec3;
|
||||||
|
|
||||||
|
const pos = Vec3M{ .data = .{ 100, 200, 300 } };
|
||||||
|
const time = Second{ .value = 10 };
|
||||||
|
|
||||||
|
// Vector divided by scalar (Velocity = Position / Time)
|
||||||
|
const vel = pos.divByScalar(time);
|
||||||
|
try std.testing.expectEqual(10, vel.data[0]);
|
||||||
|
try std.testing.expectEqual(20, vel.data[1]);
|
||||||
|
try std.testing.expectEqual(30, vel.data[2]);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(vel).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(-1, @TypeOf(vel).dims.get(.T));
|
||||||
|
|
||||||
|
// Vector multiplied by scalar (Position = Velocity * Time)
|
||||||
|
const new_pos = vel.mulByScalar(time);
|
||||||
|
try std.testing.expectEqual(100, new_pos.data[0]);
|
||||||
|
try std.testing.expectEqual(200, new_pos.data[1]);
|
||||||
|
try std.testing.expectEqual(300, new_pos.data[2]);
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(new_pos).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(0, @TypeOf(new_pos).dims.get(.T));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Element-wise Math and Scaling" {
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const Vec3M = Meter.Vec3;
|
||||||
|
|
||||||
|
const v1 = Vec3M{ .data = .{ 10, 20, 30 } };
|
||||||
|
const v2 = Vec3M{ .data = .{ 2, 5, 10 } };
|
||||||
|
|
||||||
|
// Element-wise division
|
||||||
|
const div = v1.divBy(v2);
|
||||||
|
try std.testing.expectEqual(5, div.data[0]);
|
||||||
|
try std.testing.expectEqual(4, div.data[1]);
|
||||||
|
try std.testing.expectEqual(3, div.data[2]);
|
||||||
|
try std.testing.expectEqual(0, @TypeOf(div).dims.get(.L)); // M / M = Dimensionless
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Conversions" {
|
||||||
|
const KiloMeter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{ .L = .k }));
|
||||||
|
const Meter = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
const v_km = KiloMeter.Vec3{ .data = .{ 1, 2, 3 } };
|
||||||
|
const v_m = v_km.to(Meter);
|
||||||
|
|
||||||
|
try std.testing.expectEqual(1000, v_m.data[0]);
|
||||||
|
try std.testing.expectEqual(2000, v_m.data[1]);
|
||||||
|
try std.testing.expectEqual(3000, v_m.data[2]);
|
||||||
|
|
||||||
|
// Type checking the result
|
||||||
|
try std.testing.expectEqual(1, @TypeOf(v_m).dims.get(.L));
|
||||||
|
try std.testing.expectEqual(UnitScale.none, @TypeOf(v_m).scales.get(.L));
|
||||||
|
}
|
||||||
|
|
||||||
|
test "VecX Length" {
|
||||||
|
const MeterInt = Scalar(i32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
const MeterFloat = Scalar(f32, Dimensions.init(.{ .L = 1 }), Scales.init(.{}));
|
||||||
|
|
||||||
|
// Integer length (using your custom isqrt)
|
||||||
|
// 3-4-5 triangle on XY plane
|
||||||
|
const v_int = MeterInt.Vec3{ .data = .{ 3, 4, 0 } };
|
||||||
|
try std.testing.expectEqual(25, v_int.lengthSqr());
|
||||||
|
try std.testing.expectEqual(5, v_int.length());
|
||||||
|
|
||||||
|
// Float length
|
||||||
|
const v_float = MeterFloat.Vec3{ .data = .{ 3.0, 4.0, 0.0 } };
|
||||||
|
try std.testing.expectApproxEqAbs(@as(f32, 25.0), v_float.lengthSqr(), 1e-4);
|
||||||
|
try std.testing.expectApproxEqAbs(@as(f32, 5.0), v_float.length(), 1e-4);
|
||||||
|
}
|
||||||
@ -1,6 +1,7 @@
|
|||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
const Io = std.Io;
|
const Io = std.Io;
|
||||||
const Tensor = @import("Tensor.zig").Tensor;
|
const Scalar = @import("Scalar.zig").Scalar;
|
||||||
|
const Vector = @import("Vector.zig").Vector;
|
||||||
|
|
||||||
var io: Io = undefined;
|
var io: Io = undefined;
|
||||||
pub fn main(init: std.process.Init) !void {
|
pub fn main(init: std.process.Init) !void {
|
||||||
@ -10,27 +11,14 @@ pub fn main(init: std.process.Init) !void {
|
|||||||
|
|
||||||
io = init.io;
|
io = init.io;
|
||||||
|
|
||||||
// try vectorSIMDvsNative(f64, &stdout_writer.interface);
|
try bench_Scalar(&stdout_writer.interface);
|
||||||
// try stdout_writer.flush();
|
try stdout_writer.flush();
|
||||||
// try vectorSIMDvsNative(f32, &stdout_writer.interface);
|
|
||||||
// try stdout_writer.flush();
|
|
||||||
// try vectorSIMDvsNative(i32, &stdout_writer.interface);
|
|
||||||
// try stdout_writer.flush();
|
|
||||||
// try vectorSIMDvsNative(i64, &stdout_writer.interface);
|
|
||||||
// try stdout_writer.flush();
|
|
||||||
// try vectorSIMDvsNative(i128, &stdout_writer.interface);
|
|
||||||
// try stdout_writer.flush();
|
|
||||||
//
|
|
||||||
// try bench_Scalar(&stdout_writer.interface);
|
|
||||||
// try stdout_writer.flush();
|
|
||||||
try bench_vsNative(&stdout_writer.interface);
|
try bench_vsNative(&stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
try stdout_writer.flush();
|
||||||
// try bench_crossTypeVsNative(&stdout_writer.interface);
|
try bench_crossTypeVsNative(&stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
try stdout_writer.flush();
|
||||||
try bench_Vector(&stdout_writer.interface);
|
try bench_Vector(&stdout_writer.interface);
|
||||||
try stdout_writer.flush();
|
try stdout_writer.flush();
|
||||||
try bench_HighDimTensor(&stdout_writer.interface);
|
|
||||||
try stdout_writer.flush();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn getTime() Io.Timestamp {
|
fn getTime() Io.Timestamp {
|
||||||
@ -90,17 +78,17 @@ fn bench_Scalar(writer: *std.Io.Writer) !void {
|
|||||||
\\
|
\\
|
||||||
, .{ ITERS, SAMPLES });
|
, .{ ITERS, SAMPLES });
|
||||||
|
|
||||||
const Types = .{ i16, i32, i64, i128, i256, f32, f64 };
|
const Types = .{ i16, i32, i64, i128, i256, f32, f64, f128 };
|
||||||
const TNames = .{ "i16", "i32", "i64", "i128", "i256", "f32", "f64" };
|
const TNames = .{ "i16", "i32", "i64", "i128", "i256", "f32", "f64", "f128" };
|
||||||
const Ops = .{ "add", "sub", "mul", "div", "to", "abs", "pow", "eq", "gt", "mul(n)" };
|
const Ops = .{ "add", "sub", "mulBy", "divBy", "to" };
|
||||||
|
|
||||||
var results_matrix: [Ops.len][Types.len]f64 = undefined;
|
var results_matrix: [Ops.len][Types.len]f64 = undefined;
|
||||||
|
|
||||||
comptime var tidx: usize = 0;
|
comptime var tidx: usize = 0;
|
||||||
inline for (Types, TNames) |T, tname| {
|
inline for (Types, TNames) |T, tname| {
|
||||||
const M = Tensor(T, .{ .L = 1 }, .{}, &.{1});
|
const M = Scalar(T, .init(.{ .L = 1 }), .init(.{}));
|
||||||
const KM = Tensor(T, .{ .L = 1 }, .{ .L = .k }, &.{1});
|
const KM = Scalar(T, .init(.{ .L = 1 }), .init(.{ .L = .k }));
|
||||||
const S = Tensor(T, .{ .T = 1 }, .{}, &.{1});
|
const S = Scalar(T, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, oidx| {
|
inline for (Ops, 0..) |op_name, oidx| {
|
||||||
var samples: [SAMPLES]f64 = undefined;
|
var samples: [SAMPLES]f64 = undefined;
|
||||||
@ -112,23 +100,15 @@ fn bench_Scalar(writer: *std.Io.Writer) !void {
|
|||||||
std.mem.doNotOptimizeAway(
|
std.mem.doNotOptimizeAway(
|
||||||
{
|
{
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
(M.splat(getVal(T, i, 63))).add(M.splat(getVal(T, i +% 7, 63)))
|
(M{ .value = getVal(T, i, 63) }).add(M{ .value = getVal(T, i +% 7, 63) })
|
||||||
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
||||||
(M.splat(getVal(T, i +% 10, 63))).sub(M.splat(getVal(T, i, 63)))
|
(M{ .value = getVal(T, i +% 10, 63) }).sub(M{ .value = getVal(T, i, 63) })
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
(M.splat(getVal(T, i, 63))).mul(M.splat(getVal(T, i +% 1, 63)))
|
(M{ .value = getVal(T, i, 63) }).mulBy(M{ .value = getVal(T, i +% 1, 63) })
|
||||||
else if (comptime std.mem.eql(u8, op_name, "div"))
|
else if (comptime std.mem.eql(u8, op_name, "divBy"))
|
||||||
(M.splat(getVal(T, i +% 10, 63))).div(S.splat(getVal(T, i, 63)))
|
(M{ .value = getVal(T, i +% 10, 63) }).divBy(S{ .value = getVal(T, i, 63) })
|
||||||
else if (comptime std.mem.eql(u8, op_name, "to"))
|
|
||||||
(KM.splat(getVal(T, i, 15))).to(M)
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
|
||||||
(M.splat(getVal(T, i, 63))).abs()
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "eq"))
|
|
||||||
(M.splat(getVal(T, i, 63))).eq(M.splat(getVal(T, i +% 3, 63)))
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "gt"))
|
|
||||||
(M.splat(getVal(T, i, 63))).gt(M.splat(getVal(T, i +% 3, 63)))
|
|
||||||
else
|
else
|
||||||
(M.splat(getVal(T, i, 63))).mul(3);
|
(KM{ .value = getVal(T, i, 15) }).to(M);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@ -153,9 +133,9 @@ fn bench_Scalar(writer: *std.Io.Writer) !void {
|
|||||||
try writer.print("└───────────────────┴──────┴─────────────────────┴─────────────────────┘\n\n", .{});
|
try writer.print("└───────────────────┴──────┴─────────────────────┴─────────────────────┘\n\n", .{});
|
||||||
try writer.print("Median Summary (ns/op):\n", .{});
|
try writer.print("Median Summary (ns/op):\n", .{});
|
||||||
|
|
||||||
try writer.print("┌──────────────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┐\n", .{});
|
try writer.print("┌──────────────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┬───────┐\n", .{});
|
||||||
try writer.print("│ Operation │ i16 │ i32 │ i64 │ i128 │ i256 │ f32 │ f64 │\n", .{});
|
try writer.print("│ Operation │ i16 │ i32 │ i64 │ i128 │ i256 │ f32 │ f64 │ f128 │\n", .{});
|
||||||
try writer.print("├──────────────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┤\n", .{});
|
try writer.print("├──────────────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┼───────┤\n", .{});
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, oidx| {
|
inline for (Ops, 0..) |op_name, oidx| {
|
||||||
try writer.print("│ {s:<11} │", .{op_name});
|
try writer.print("│ {s:<11} │", .{op_name});
|
||||||
@ -166,13 +146,14 @@ fn bench_Scalar(writer: *std.Io.Writer) !void {
|
|||||||
try writer.print("\n", .{});
|
try writer.print("\n", .{});
|
||||||
}
|
}
|
||||||
|
|
||||||
try writer.print("└──────────────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┘\n", .{});
|
try writer.print("└──────────────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┴───────┘\n", .{});
|
||||||
}
|
}
|
||||||
|
|
||||||
fn bench_vsNative(writer: *std.Io.Writer) !void {
|
fn bench_vsNative(writer: *std.Io.Writer) !void {
|
||||||
const ITERS: usize = 100_000;
|
const ITERS: usize = 100_000;
|
||||||
const SAMPLES: usize = 100;
|
const SAMPLES: usize = 5;
|
||||||
|
|
||||||
|
// Helper to safely get a value of type T from a loop index
|
||||||
const getValT = struct {
|
const getValT = struct {
|
||||||
fn f(comptime TT: type, i: usize) TT {
|
fn f(comptime TT: type, i: usize) TT {
|
||||||
const v = (i % 100) + 1;
|
const v = (i % 100) + 1;
|
||||||
@ -180,124 +161,74 @@ fn bench_vsNative(writer: *std.Io.Writer) !void {
|
|||||||
}
|
}
|
||||||
}.f;
|
}.f;
|
||||||
|
|
||||||
const Types = .{ f64, i64, i128, f32, f64 };
|
const Types = .{ i32, i64, i128, f32, f64 };
|
||||||
const TNames = .{ "f64", "i64", "i128", "f32", "f64" };
|
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
||||||
// Expanded Ops to match bench_Scalar
|
const Ops = .{ "add", "mulBy", "divBy" };
|
||||||
const Ops = .{ "add", "sub", "mul", "div", "abs", "eq", "gt" };
|
|
||||||
|
|
||||||
try writer.print(
|
try writer.print(
|
||||||
\\
|
\\
|
||||||
\\ Scalar vs Native Overhead Analysis
|
\\ Scalar vs Native Overhead Analysis
|
||||||
\\
|
\\
|
||||||
\\┌───────────┬──────┬───────────┬───────────┬───────────┬───────────────────────┐
|
\\┌───────────┬──────┬───────────┬───────────┬───────────┐
|
||||||
\\│ Operation │ Type │ Native │ @Vector │ Tensor{{1}} │ Slowdown Nat | Vec │
|
\\│ Operation │ Type │ Native │ Scalar │ Slowdown │
|
||||||
\\├───────────┼──────┼───────────┼───────────┼───────────┼───────────────────────┤
|
\\├───────────┼──────┼───────────┼───────────┼───────────┤
|
||||||
\\
|
\\
|
||||||
, .{});
|
, .{});
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, j| {
|
inline for (Ops, 0..) |op_name, j| {
|
||||||
inline for (Types, 0..) |T, tidx| {
|
inline for (Types, 0..) |T, tidx| {
|
||||||
var native_total_ns: f64 = 0;
|
var native_total_ns: f64 = 0;
|
||||||
var vector_total_ns: f64 = 0;
|
var quantity_total_ns: f64 = 0;
|
||||||
var tensor_total_ns: f64 = 0;
|
|
||||||
|
|
||||||
const M = Tensor(T, .{}, .{}, &.{1});
|
const M = Scalar(T, .init(.{ .L = 1 }), .init(.{}));
|
||||||
|
const S = Scalar(T, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
|
||||||
std.mem.doNotOptimizeAway({
|
std.mem.doNotOptimizeAway({
|
||||||
for (0..SAMPLES) |_| {
|
for (0..SAMPLES) |_| {
|
||||||
// --- 1. Benchmark Native ---
|
// --- 1. Benchmark Native ---
|
||||||
const n_start = getTime();
|
const n_start = getTime();
|
||||||
const a = getValT(T, 10);
|
for (0..ITERS) |i| {
|
||||||
const b = getValT(T, 2);
|
const a = getValT(T, i);
|
||||||
for (0..ITERS) |_| {
|
const b = getValT(T, 2);
|
||||||
// Native logic branch
|
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
if (comptime @typeInfo(T) == .int) a +| b else a + b
|
a + b
|
||||||
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
if (comptime @typeInfo(T) == .int) a -| b else a - b
|
a * b
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
else if (comptime @typeInfo(T) == .int) @divTrunc(a, b) else a / b;
|
||||||
if (comptime @typeInfo(T) == .int) a *| b else a * b
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "div"))
|
|
||||||
if (comptime @typeInfo(T) == .int) @divTrunc(a, b) else a / b
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
|
||||||
if (comptime @typeInfo(T) == .int) @abs(a) else @as(T, @abs(a))
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "eq"))
|
|
||||||
a == b
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "gt"))
|
|
||||||
a > b
|
|
||||||
else
|
|
||||||
unreachable;
|
|
||||||
}
|
}
|
||||||
const n_end = getTime();
|
const n_end = getTime();
|
||||||
native_total_ns += @as(f64, @floatFromInt(n_start.durationTo(n_end).toNanoseconds()));
|
native_total_ns += @as(f64, @floatFromInt(n_start.durationTo(n_end).toNanoseconds()));
|
||||||
|
|
||||||
const v_start = getTime();
|
|
||||||
const va = getValT(T, 10);
|
|
||||||
const vb = getValT(T, 2);
|
|
||||||
for (0..ITERS) |_| {
|
|
||||||
// Native logic branch
|
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
|
||||||
if (comptime @typeInfo(T) == .int) va +| vb else va + vb
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
|
||||||
if (comptime @typeInfo(T) == .int) va -| vb else va - vb
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
|
||||||
if (comptime @typeInfo(T) == .int) va *| vb else va * vb
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "div"))
|
|
||||||
if (comptime @typeInfo(T) == .int) @divTrunc(va, vb) else va / vb
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
|
||||||
if (comptime @typeInfo(T) == .int) @abs(va) else @as(T, @abs(va))
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "eq"))
|
|
||||||
va == vb
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "gt"))
|
|
||||||
va > vb
|
|
||||||
else
|
|
||||||
unreachable;
|
|
||||||
}
|
|
||||||
const v_end = getTime();
|
|
||||||
vector_total_ns += @as(f64, @floatFromInt(v_start.durationTo(v_end).toNanoseconds()));
|
|
||||||
|
|
||||||
// --- 2. Benchmark Scalar ---
|
// --- 2. Benchmark Scalar ---
|
||||||
const q_start = getTime();
|
const q_start = getTime();
|
||||||
const qa = M.splat(getValT(T, 10));
|
for (0..ITERS) |i| {
|
||||||
const qb = M.splat(getValT(T, 2));
|
const qa = M{ .value = getValT(T, i) };
|
||||||
for (0..ITERS) |_| {
|
const qb = if (comptime std.mem.eql(u8, op_name, "divBy")) S{ .value = getValT(T, 2) } else M{ .value = getValT(T, 2) };
|
||||||
// Scalar logic branch
|
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
qa.add(qb)
|
qa.add(qb)
|
||||||
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
qa.sub(qb)
|
qa.mulBy(qb)
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
|
||||||
qa.mul(qb)
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "div"))
|
|
||||||
qa.div(qb)
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
|
||||||
qa.abs()
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "eq"))
|
|
||||||
qa.eq(qb)
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "gt"))
|
|
||||||
qa.gt(qb)
|
|
||||||
else
|
else
|
||||||
unreachable;
|
qa.divBy(qb);
|
||||||
}
|
}
|
||||||
const q_end = getTime();
|
const q_end = getTime();
|
||||||
tensor_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
quantity_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
const avg_n = (native_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
const avg_n = (native_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
const avg_v = (vector_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
const avg_q = (quantity_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
||||||
const avg_t = (tensor_total_ns / SAMPLES) / @as(f64, @floatFromInt(ITERS));
|
const slowdown = avg_q / avg_n;
|
||||||
const slowdown_nt = avg_t / avg_n;
|
|
||||||
const slowdown_vt = avg_t / avg_v;
|
|
||||||
|
|
||||||
try writer.print("│ {s:<9} │ {s:<4} │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>8.2}x {d:>8.2}x │\n", .{
|
try writer.print("│ {s:<9} │ {s:<4} │ {d:>7.2}ns │ {d:>7.2}ns │ {d:>8.2}x │\n", .{
|
||||||
op_name, TNames[tidx], avg_n, avg_v, avg_t, slowdown_nt, slowdown_vt,
|
op_name, TNames[tidx], avg_n, avg_q, slowdown,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
if (j != Ops.len - 1) try writer.print("├───────────┼──────┼───────────┼───────────┼───────────┼───────────────────────┤\n", .{});
|
if (j != Ops.len - 1) try writer.print("├───────────┼──────┼───────────┼───────────┼───────────┤\n", .{});
|
||||||
}
|
}
|
||||||
|
|
||||||
try writer.print("└───────────┴──────┴───────────┴───────────┴───────────┴───────────────────────┘\n", .{});
|
try writer.print("└───────────┴──────┴───────────┴───────────┴───────────┘\n", .{});
|
||||||
}
|
}
|
||||||
|
|
||||||
fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
||||||
@ -329,7 +260,7 @@ fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
|||||||
|
|
||||||
const Types = .{ i16, i64, i128, f32, f64 };
|
const Types = .{ i16, i64, i128, f32, f64 };
|
||||||
const TNames = .{ "i16", "i64", "i128", "f32", "f64" };
|
const TNames = .{ "i16", "i64", "i128", "f32", "f64" };
|
||||||
const Ops = .{ "add", "mul", "div" };
|
const Ops = .{ "add", "mulBy", "divBy" };
|
||||||
|
|
||||||
try writer.print(
|
try writer.print(
|
||||||
\\
|
\\
|
||||||
@ -347,9 +278,9 @@ fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
|||||||
var native_total_ns: f64 = 0;
|
var native_total_ns: f64 = 0;
|
||||||
var quantity_total_ns: f64 = 0;
|
var quantity_total_ns: f64 = 0;
|
||||||
|
|
||||||
const M1 = Tensor(T1, .{ .L = 1 }, .{}, &.{1});
|
const M1 = Scalar(T1, .init(.{ .L = 1 }), .init(.{}));
|
||||||
const M2 = Tensor(T2, .{ .L = 1 }, .{}, &.{1});
|
const M2 = Scalar(T2, .init(.{ .L = 1 }), .init(.{}));
|
||||||
const S2 = Tensor(T2, .{ .T = 1 }, .{}, &.{1});
|
const S2 = Scalar(T2, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
|
||||||
std.mem.doNotOptimizeAway({
|
std.mem.doNotOptimizeAway({
|
||||||
for (0..SAMPLES) |_| {
|
for (0..SAMPLES) |_| {
|
||||||
@ -362,7 +293,7 @@ fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
|||||||
|
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
a + b
|
a + b
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
a * b
|
a * b
|
||||||
else if (comptime @typeInfo(T1) == .int)
|
else if (comptime @typeInfo(T1) == .int)
|
||||||
@divTrunc(a, b)
|
@divTrunc(a, b)
|
||||||
@ -375,18 +306,18 @@ fn bench_crossTypeVsNative(writer: *std.Io.Writer) !void {
|
|||||||
// --- 2. Benchmark Scalar ---
|
// --- 2. Benchmark Scalar ---
|
||||||
const q_start = getTime();
|
const q_start = getTime();
|
||||||
for (0..ITERS) |i| {
|
for (0..ITERS) |i| {
|
||||||
const qa = M1.splat(getValT(T1, i));
|
const qa = M1{ .value = getValT(T1, i) };
|
||||||
const qb = if (comptime std.mem.eql(u8, op_name, "div"))
|
const qb = if (comptime std.mem.eql(u8, op_name, "divBy"))
|
||||||
S2.splat(getValT(T2, 2))
|
S2{ .value = getValT(T2, 2) }
|
||||||
else
|
else
|
||||||
M2.splat(getValT(T2, 2));
|
M2{ .value = getValT(T2, 2) };
|
||||||
|
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
||||||
qa.add(qb)
|
qa.add(qb)
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mul"))
|
else if (comptime std.mem.eql(u8, op_name, "mulBy"))
|
||||||
qa.mul(qb)
|
qa.mulBy(qb)
|
||||||
else
|
else
|
||||||
qa.div(qb);
|
qa.divBy(qb);
|
||||||
}
|
}
|
||||||
const q_end = getTime();
|
const q_end = getTime();
|
||||||
quantity_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
quantity_total_ns += @as(f64, @floatFromInt(q_start.durationTo(q_end).toNanoseconds()));
|
||||||
@ -436,34 +367,27 @@ fn bench_Vector(writer: *std.Io.Writer) !void {
|
|||||||
try writer.print(
|
try writer.print(
|
||||||
\\
|
\\
|
||||||
\\ Vector<N, T> benchmark — {d} iterations, {d} samples/cell
|
\\ Vector<N, T> benchmark — {d} iterations, {d} samples/cell
|
||||||
\\ (Results in ns/op; "---" = not applicable for this length)
|
\\ (Results in ns/op)
|
||||||
\\
|
\\
|
||||||
\\┌──────────────────┬──────┬─────────┬─────────┬─────────┬─────────┬─────────┐
|
\\┌─────────────┬──────┬─────────┬─────────┬─────────┐
|
||||||
\\│ Operation │ Type │ Len=1 │ Len=3 │ Len=4 │ Len=16 │ Len=100 │
|
\\│ Operation │ Type │ Len=3 │ Len=4 │ Len=16 │
|
||||||
\\├──────────────────┼──────┼─────────┼─────────┼─────────┼─────────┼─────────┤
|
\\├─────────────┼──────┼─────────┼─────────┼─────────┤
|
||||||
\\
|
\\
|
||||||
, .{ ITERS, SAMPLES });
|
, .{ ITERS, SAMPLES });
|
||||||
|
|
||||||
const Types = .{ i32, i64, i128, f32, f64 };
|
const Types = .{ i32, i64, i128, f32, f64 };
|
||||||
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
const TNames = .{ "i32", "i64", "i128", "f32", "f64" };
|
||||||
const Lengths = .{ 1, 3, 4, 16, 100 };
|
const Lengths = .{ 3, 4, 16 };
|
||||||
// "cross" is only valid for len=3; other cells will show " --- "
|
const Ops = .{ "add", "divBy", "mulByScalar", "length" };
|
||||||
const Ops = .{ "add", "div", "mulScalar", "dot", "cross", "product", "pow", "length" };
|
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, o_idx| {
|
inline for (Ops, 0..) |op_name, o_idx| {
|
||||||
inline for (Types, TNames) |T, tname| {
|
inline for (Types, TNames) |T, tname| {
|
||||||
try writer.print("│ {s:<16} │ {s:<4} │", .{ op_name, tname });
|
try writer.print("│ {s:<11} │ {s:<4} │", .{ op_name, tname });
|
||||||
|
|
||||||
inline for (Lengths) |len| {
|
inline for (Lengths) |len| {
|
||||||
const Q_time = Tensor(T, .{ .T = 1 }, .{}, &.{1});
|
const Q_base = Scalar(T, .init(.{ .L = 1 }), .init(.{}));
|
||||||
const V = Tensor(T, .{ .L = 1 }, .{}, &.{len});
|
const Q_time = Scalar(T, .init(.{ .T = 1 }), .init(.{}));
|
||||||
|
const V = Vector(len, Q_base);
|
||||||
// cross product is only defined for len == 3
|
|
||||||
const is_cross = comptime std.mem.eql(u8, op_name, "cross");
|
|
||||||
if (comptime is_cross and len != 3) {
|
|
||||||
try writer.print(" --- │", .{});
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
var samples: [SAMPLES]f64 = undefined;
|
var samples: [SAMPLES]f64 = undefined;
|
||||||
|
|
||||||
@ -471,27 +395,16 @@ fn bench_Vector(writer: *std.Io.Writer) !void {
|
|||||||
for (0..SAMPLES) |s_idx| {
|
for (0..SAMPLES) |s_idx| {
|
||||||
const t_start = getTime();
|
const t_start = getTime();
|
||||||
for (0..ITERS) |i| {
|
for (0..ITERS) |i| {
|
||||||
const v1 = V.splat(getVal(T, i, 63));
|
const v1 = V.initDefault(getVal(T, i, 63));
|
||||||
|
|
||||||
if (comptime std.mem.eql(u8, op_name, "add")) {
|
if (comptime std.mem.eql(u8, op_name, "add")) {
|
||||||
const v2 = V.splat(getVal(T, i +% 7, 63));
|
const v2 = V.initDefault(getVal(T, i +% 7, 63));
|
||||||
_ = v1.add(v2);
|
_ = v1.add(v2);
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "div")) {
|
} else if (comptime std.mem.eql(u8, op_name, "divBy")) {
|
||||||
_ = v1.div(V.splat(getVal(T, i +% 2, 63)));
|
_ = v1.divBy(V.initDefault(getVal(T, i +% 2, 63)));
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "mulScalar")) {
|
} else if (comptime std.mem.eql(u8, op_name, "mulByScalar")) {
|
||||||
const s_val = Q_time.splat(getVal(T, i +% 2, 63));
|
const s_val = Q_time{ .value = getVal(T, i +% 2, 63) };
|
||||||
_ = v1.mul(s_val);
|
_ = v1.mulByScalar(s_val);
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "dot")) {
|
|
||||||
const v2 = V.splat(getVal(T, i +% 5, 63));
|
|
||||||
_ = v1.contract(v2, 0, 0);
|
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "cross")) {
|
|
||||||
// len == 3 guaranteed by the guard above
|
|
||||||
const v2 = V.splat(getVal(T, i +% 5, 63));
|
|
||||||
_ = v1.cross(v2);
|
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "product")) {
|
|
||||||
_ = v1.product();
|
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "pow")) {
|
|
||||||
_ = v1.pow(2);
|
|
||||||
} else if (comptime std.mem.eql(u8, op_name, "length")) {
|
} else if (comptime std.mem.eql(u8, op_name, "length")) {
|
||||||
_ = v1.length();
|
_ = v1.length();
|
||||||
}
|
}
|
||||||
@ -509,163 +422,8 @@ fn bench_Vector(writer: *std.Io.Writer) !void {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (o_idx < Ops.len - 1) {
|
if (o_idx < Ops.len - 1) {
|
||||||
try writer.print("├──────────────────┼──────┼─────────┼─────────┼─────────┼─────────┼─────────┤\n", .{});
|
try writer.print("├─────────────┼──────┼─────────┼─────────┼─────────┤\n", .{});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
try writer.print("└──────────────────┴──────┴─────────┴─────────┴─────────┴─────────┴─────────┘\n", .{});
|
try writer.print("└─────────────┴──────┴─────────┴─────────┴─────────┘\n", .{});
|
||||||
}
|
|
||||||
|
|
||||||
fn bench_HighDimTensor(writer: *std.Io.Writer) !void {
|
|
||||||
const ITERS: usize = 5_000;
|
|
||||||
const SAMPLES: usize = 5;
|
|
||||||
|
|
||||||
const getVal = struct {
|
|
||||||
fn f(comptime TT: type, i: usize, comptime mask: u7) TT {
|
|
||||||
const v: u8 = @as(u8, @truncate(i & @as(usize, mask))) + 1;
|
|
||||||
return if (comptime @typeInfo(TT) == .float) @floatFromInt(v) else @intCast(v);
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
const computeStats = struct {
|
|
||||||
fn f(samples: []f64, iters: usize) f64 {
|
|
||||||
std.mem.sort(f64, samples, {}, std.sort.asc(f64));
|
|
||||||
const mid = samples.len / 2;
|
|
||||||
const median_ns = if (samples.len % 2 == 0)
|
|
||||||
(samples[mid - 1] + samples[mid]) / 2.0
|
|
||||||
else
|
|
||||||
samples[mid];
|
|
||||||
return median_ns / @as(f64, @floatFromInt(iters));
|
|
||||||
}
|
|
||||||
}.f;
|
|
||||||
|
|
||||||
try writer.print(
|
|
||||||
\\
|
|
||||||
\\ High Dimension Tensor benchmark — {d} iterations, {d} samples/cell
|
|
||||||
\\ (Results in ns/op)
|
|
||||||
\\
|
|
||||||
\\┌─────────────────┬──────┬──────────────┬──────────────┬──────────────┬──────────────┐
|
|
||||||
\\│ Operation │ Type │ 2x2x2 │ 3x3x3 │ 4x4x4 │ 10x10x10x10 │
|
|
||||||
\\├─────────────────┼──────┼──────────────┼──────────────┼──────────────┼──────────────┤
|
|
||||||
\\
|
|
||||||
, .{ ITERS, SAMPLES });
|
|
||||||
|
|
||||||
const Types = .{ i32, i64, f32, f64 };
|
|
||||||
const TNames = .{ "i32", "i64", "f32", "f64" };
|
|
||||||
|
|
||||||
// Testing multiple structural bounds
|
|
||||||
const Shapes = .{
|
|
||||||
&.{ 2, 2, 2 },
|
|
||||||
&.{ 3, 3, 3 },
|
|
||||||
&.{ 4, 4, 4 },
|
|
||||||
&.{ 10, 10, 10, 10 },
|
|
||||||
};
|
|
||||||
|
|
||||||
const Ops = .{ "add", "sub", "mulElem", "mulScalar", "abs" };
|
|
||||||
|
|
||||||
inline for (Ops, 0..) |op_name, o_idx| {
|
|
||||||
inline for (Types, TNames) |T, tname| {
|
|
||||||
try writer.print("│ {s:<15} │ {s:<4} │", .{ op_name, tname });
|
|
||||||
|
|
||||||
inline for (Shapes) |shape| {
|
|
||||||
const V = Tensor(T, .{ .L = 1 }, .{}, shape);
|
|
||||||
const Q = Tensor(T, .{ .T = 1 }, .{}, &.{1}); // For scalar broadcasting operations
|
|
||||||
|
|
||||||
var samples: [SAMPLES]f64 = undefined;
|
|
||||||
|
|
||||||
for (0..SAMPLES) |s_idx| {
|
|
||||||
const t_start = getTime();
|
|
||||||
|
|
||||||
for (0..ITERS) |i| {
|
|
||||||
std.mem.doNotOptimizeAway({
|
|
||||||
const t1 = V.splat(getVal(T, i, 63));
|
|
||||||
|
|
||||||
_ = if (comptime std.mem.eql(u8, op_name, "add"))
|
|
||||||
t1.add(V.splat(getVal(T, i +% 7, 63)))
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "sub"))
|
|
||||||
t1.sub(V.splat(getVal(T, i +% 3, 63)))
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mulElem"))
|
|
||||||
t1.mul(V.splat(getVal(T, i +% 5, 63)))
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "mulScalar"))
|
|
||||||
t1.mul(Q.splat(getVal(T, i +% 2, 63)))
|
|
||||||
else if (comptime std.mem.eql(u8, op_name, "abs"))
|
|
||||||
t1.abs()
|
|
||||||
else
|
|
||||||
unreachable;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const t_end = getTime();
|
|
||||||
samples[s_idx] = @as(f64, @floatFromInt(t_start.durationTo(t_end).toNanoseconds()));
|
|
||||||
}
|
|
||||||
|
|
||||||
const median_ns_per_op = computeStats(&samples, ITERS);
|
|
||||||
try writer.print(" {d:>12.1} │", .{median_ns_per_op});
|
|
||||||
}
|
|
||||||
try writer.print("\n", .{});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (o_idx < Ops.len - 1) {
|
|
||||||
try writer.print("├─────────────────┼──────┼──────────────┼──────────────┼──────────────┼──────────────┤\n", .{});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
try writer.print("└─────────────────┴──────┴──────────────┴──────────────┴──────────────┴──────────────┘\n", .{});
|
|
||||||
}
|
|
||||||
|
|
||||||
fn vectorSIMDvsNative(comptime T: type, writer: *std.Io.Writer) !void {
|
|
||||||
const iterations: u64 = 10_000;
|
|
||||||
const lens = [_]u32{ 1, 2, 3, 4, 5, 10, 100, 1_000, 10_000 };
|
|
||||||
|
|
||||||
try writer.print("\nSIMD Speedup Analysis: {s}\n", .{@typeName(T)});
|
|
||||||
try writer.print("┌────────────┬────────────┬────────────┬────────────┐\n", .{});
|
|
||||||
try writer.print("│ Vector Len │ Scalar (us)│ Vector (us)│ Speedup │\n", .{});
|
|
||||||
try writer.print("├────────────┼────────────┼────────────┼────────────┤\n", .{});
|
|
||||||
|
|
||||||
inline for (lens) |vector_len| {
|
|
||||||
// --- Scalar Test ---
|
|
||||||
var scalar_val: T = 10;
|
|
||||||
const start_scalar = getTime();
|
|
||||||
|
|
||||||
var i: u64 = 0;
|
|
||||||
while (i < iterations * vector_len) : (i += 1) {
|
|
||||||
if (comptime @typeInfo(T) == .int)
|
|
||||||
scalar_val = scalar_val +% 1
|
|
||||||
else
|
|
||||||
scalar_val = scalar_val + 1;
|
|
||||||
}
|
|
||||||
const scalar_time = start_scalar.durationTo(getTime()).toMicroseconds();
|
|
||||||
|
|
||||||
// --- Vector Test ---
|
|
||||||
var vector_val: @Vector(vector_len, T) = @splat(20);
|
|
||||||
const start_vector = getTime();
|
|
||||||
|
|
||||||
i = 0;
|
|
||||||
const increment: @Vector(vector_len, T) = @splat(1);
|
|
||||||
while (i < iterations) : (i += 1) {
|
|
||||||
if (comptime @typeInfo(T) == .int)
|
|
||||||
vector_val = vector_val +% increment
|
|
||||||
else
|
|
||||||
vector_val = vector_val + increment;
|
|
||||||
}
|
|
||||||
const vector_time = start_vector.durationTo(getTime()).toMicroseconds();
|
|
||||||
|
|
||||||
// --- Results ---
|
|
||||||
const s_float = @as(f64, @floatFromInt(scalar_time));
|
|
||||||
const v_float = @as(f64, @floatFromInt(vector_time));
|
|
||||||
|
|
||||||
// Speedup = ScalarTime / VectorTime.
|
|
||||||
// > 1.0 means SIMD is faster.
|
|
||||||
const speedup = if (vector_time > 0) s_float / v_float else 0;
|
|
||||||
|
|
||||||
try writer.print("│ {d:<10} │ {d:>10} │ {d:>10} │ {d:>9.2}x │\n", .{
|
|
||||||
vector_len,
|
|
||||||
scalar_time,
|
|
||||||
vector_time,
|
|
||||||
speedup,
|
|
||||||
});
|
|
||||||
try writer.flush();
|
|
||||||
|
|
||||||
std.mem.doNotOptimizeAway(scalar_val);
|
|
||||||
std.mem.doNotOptimizeAway(vector_val);
|
|
||||||
}
|
|
||||||
try writer.print("└────────────┴────────────┴────────────┴────────────┘\n", .{});
|
|
||||||
}
|
}
|
||||||
|
|||||||
32
src/helper.zig
Normal file
32
src/helper.zig
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
const std = @import("std");
|
||||||
|
|
||||||
|
pub fn isInt(comptime T: type) bool {
|
||||||
|
return @typeInfo(T) == .int or @typeInfo(T) == .comptime_int;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn printSuperscript(writer: *std.Io.Writer, n: i32) !void {
|
||||||
|
if (n == 0) return;
|
||||||
|
var val = n;
|
||||||
|
if (val < 0) {
|
||||||
|
try writer.writeAll("\u{207B}");
|
||||||
|
val = -val;
|
||||||
|
}
|
||||||
|
var buf: [12]u8 = undefined;
|
||||||
|
const str = std.fmt.bufPrint(&buf, "{d}", .{val}) catch return;
|
||||||
|
for (str) |c| {
|
||||||
|
const s = switch (c) {
|
||||||
|
'0' => "\u{2070}",
|
||||||
|
'1' => "\u{00B9}",
|
||||||
|
'2' => "\u{00B2}",
|
||||||
|
'3' => "\u{00B3}",
|
||||||
|
'4' => "\u{2074}",
|
||||||
|
'5' => "\u{2075}",
|
||||||
|
'6' => "\u{2076}",
|
||||||
|
'7' => "\u{2077}",
|
||||||
|
'8' => "\u{2078}",
|
||||||
|
'9' => "\u{2079}",
|
||||||
|
else => unreachable,
|
||||||
|
};
|
||||||
|
try writer.writeAll(s);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,13 +1,16 @@
|
|||||||
const std = @import("std");
|
const std = @import("std");
|
||||||
|
|
||||||
pub const Tensor = @import("Tensor.zig").Tensor;
|
pub const Scalar = @import("Scalar.zig").Scalar;
|
||||||
|
pub const Vector = @import("Vector.zig").Vector;
|
||||||
pub const Dimensions = @import("Dimensions.zig");
|
pub const Dimensions = @import("Dimensions.zig");
|
||||||
pub const Scales = @import("Scales.zig");
|
pub const Scales = @import("Scales.zig");
|
||||||
pub const Base = @import("Base.zig");
|
pub const Base = @import("Base.zig");
|
||||||
|
|
||||||
test {
|
test {
|
||||||
_ = @import("Tensor.zig");
|
_ = @import("Scalar.zig");
|
||||||
|
_ = @import("Vector.zig");
|
||||||
_ = @import("Dimensions.zig");
|
_ = @import("Dimensions.zig");
|
||||||
_ = @import("Scales.zig");
|
_ = @import("Scales.zig");
|
||||||
_ = @import("Base.zig");
|
_ = @import("Base.zig");
|
||||||
|
_ = @import("helper.zig");
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user