You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Old Silk.NET.Maths classes are kept in aLegacy/ folder, this is just temporary and will be removed. If you'd like this to be split up into multiple smaller PRs let me know.
Hi! I just wanted to share that I have also been working on this a bit. I have a script that generates a lot of this code using roslyn. I have the vector and matrix implementations for storage and equality as well as a scaffold of the matrix multiplication operators.
(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement
Contribution License Agreement
This Contribution License Agreement (“Agreement” ) is agreed to by the party signing below (“You” ), and conveys certain license rights to the .NET Foundation (“.NET Foundation” ) for Your contributions to .NET Foundation open source projects. This Agreement is effective as of the latest signature date below.
1. Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to .NET Foundation under this Agreement.
“Project” means any of the projects owned or managed by .NET Foundation and offered under a license approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as you received them, (b) in the description accompanying your Submission, include the phrase "Submission containing materials of a third party:" followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project's written guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
5. Licenses.
a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
6. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3 ). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
8. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.
.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.
Implements IEquatable with itself as the generic parameter
Implements IReadOnlyList with the components as the list elements
Implements ISpanFormattable
Implements ISpanParsable
Implements IUtf8SpanFormattable
Implements IUtf8SpanParsable
Implements IParsable
Implemetns IFormattable
The relevant number of properties to represent the mathematical vector's components (X and Y for Vector2) and relevant unit vectors
Constructors which take either a single parameter and uses it for every component, a parameter for each component, or a ReadOnlySpan of values which has the same number of elements as our vector has components.
Constructors for 3 dimensions and upmust include lower dimension variants that use the lower dimensions for their specific components (vector2 -> X,Y).
A ref indexer that takes a int index and returns the corresponding component value (0 -> x, 1 -> y, etc.)
An AsSpan function which returns this vector as a Span of the generic type
A LengthSquared extension property which returns the dot product of the vector with itself.
A Length extension property which returns the magnitued of the vector when the typeT definesIRootFunctions<T>.
A Dot static method which takes another vector and returns the dot product with our original vector.
For 3D Vectors, a Cross static method which takes another vector and returns the cross product with our original vector.
+,-,*,/, and% operators defined between two vectors of the same type which returns a vector which has had each operation applied component-wise.
+,-,*,/, and% operators defined between a vector and a scalar value that matches the generic type which returns a vector which has had each operation applied component-wise with the scalar value. Both vector first and scalar first should be implemented.
A- unary operator which returns the negated vector.
A+ unary operator which returns the vector.
Overrides ToString to show component values.
CopyTo functions which copy to an array or span, with or without a starting index
Explicit cast and checked cast operators to all builtin type parameter variants of the vector types of the same dimensionality. (e.g. fromVector2D<T> toVector2D<float>)
Explicit cast and checked cast to and from matching System.Numerics vector type
Explicit cast cast to lower dimensional matching vector with matching generic type
Static Unit Vectors for each component
A Static Zero Vector with zero for all components
A Static One Vector with one for all components
A static AllBitsSet Vector with all bits set for all components
A deconstruct method for detupling
An implicit conversion from a value tuple of the same size.
Define static CreateChecked, CreateSaturating, and CreateTruncating which converts other vector types to this type
Try variants of these methods should also be defined which out the resulting vector and return a bool representing success or failure of the operation.
Define Transform static methods which take a Matrix of higher dimensionality assuming 1 in for the final missing component and 0 for the rest (Vector 2 can useMatrix2Xn,Matrix3Xn, andMatrix4Xn) and return a vector containing the output (type should match the outer type e.g.Vector2D.Transform(Matrix4X4) returnsVector2D)
DefineVectorND<T> * MatrixNXM operators where N is the same for both Vector and Matrix, but M is any number
These operators should function like Transform, but without needed assumptions
Define TransformNormal static methods which take a Matrix of higher dimensionality assuming 0 in for all missing components (Vector 2 can useMatrix2Xn,Matrix3Xn, andMatrix4Xn) and return a vector containing the output (type should match the outer type e.g.Vector2D.Transform(Matrix4X4) returnsVector2D)
For types implementing IBinaryNumber
BitwiseAnd,BitwiseOr, andBitwiseXor static methods defined between two vectors which returns a vector which has had these operators applied on a component-wise basis.
BitwiseAnd,BitwiseOr, andBitwiseXor static methods operators defined between a vectors and a scalar value that matches the generic type which returns a vector which has had these operators applied on a component-wise basis with the scalar.
BitwiseNot static method defined which negates the bits of the vector components. (BitwiseComplement?)
A Normalize extension method which divides all components by the length of the vector, whenT implementsIRootFunctions<T>
A Reflect static method which takes a normal vector and reflects the vector over the normal
The following static Vector properties which have the given value for all components
PositiveInfinity
NegativeInfinity
NaN
Epsilon
NegativeZero
Pi
Tau
E
Define the following static methods for these types which calls the specified function and returns a new vector with the specified multiplicity:
INumber<>.Sign, (Memberwise)
ReturnsVectorND<int>, where N matches the dimensionality of the vector
Matrix structsmust fulfill the following requirements:
FulfillsIEquatable<T> whereT is the same matrix class
Stored in row major format
Both row vectors and individual values (M11, etc.) accessible via properties
A ref indexer that takes row and column indicies and outputs the value
Add, subtract, and multiply operators defined with Matricies of the same size
Multiply operators defined with compatible matricies, if the output matrix type already exists (AxB * BxC = AxC)
Negate Operator defined
Implicit conversion to and from the System.Numerics matrix type, if available
Invert extension method for square matricies
GetDeterminant extension method for square matricies and Matrix3X2, Matrix4X3, and Matrix5X4
Transpose extension method
Lerp static method
static identity property for square matrices
For Matrix3X2, Matrix3X3, Matrix4X3, and Matrix4X4 include the following static functions
CreateBillboardRH
CreateBillboardLH
CreateRotation
3x3, 4x3, and 4x4 Matricies get X, Y, and Z variants for this function instead
CreateTranslation
CreateScale
Decompose (separate out any transformations)
For Matrix3X2 include a CreateSkew static function
For Matrix3X3, Matrix4X3, and Matrix4X4 include the following static functions
CreateFromAxisAngle
CreateFromQuaternion
Transform
from a Quaternion
CreateFromYawPitchRoll
For Matrix4X3 and Matrix4X4 include the following static functions
CreateConstrainedBillboardLH
CreateConstrainedBillboardRH
CreateLookAtLH
CreateLookToLH
CreateOrthographicLH
CreateOrthographicOffCenterLH
CreatePerspectiveLH
CreatePerspectiveFieldOfViewLH
CreatePerspectiveOffCenterLH
CreateLookAtRH
CreateLookToRH
CreateOrthographicRH
CreateOrthographicOffCenterRH
CreatePerspectiveRH
CreatePerspectiveFieldOfViewRH
CreatePerspectiveOffCenterRH
CreateReflection
CreateWorld
CreateViewport
Several of these functions exist, but not for all types or not for both LH/RH versions.
A Quaternion struct:
A generic struct with a type parameterT which is constrained byIBinaryFloatingPointIeee754<T> representing the scalar type
Implements IEquatable with itself
Contain 4 scalar properties (X, Y, Z, W)
Define a Constructor taking 4 scalar values matching the properties
Define a Constructor taking aVector3D<T> and a Scalar, with the vector 3 mapping to X, Y, Z and the Scalar to the W
Define a Constructor taking aVector4D<T>
AVector3D<T> Axis property mapping to (X, Y, Z)
A T Angle property mapping to 2 * Acos(W)
A ref Indexer which takes an int and returns the components in order
An AsSpan function which returns this quaternion as a Span of the generic type
An IsIdentity property which returns if this Quaternion matches an Identity Quaternion
Define+,-,*, and/ between two Quaternions
Define* withT multiplying each component by the scalar value returning a new quaternion
Define unary~
A Dot function which takes another Quaternion and returns its the dotproduct between them
A static implementation of this functionmust be available
A LengthSquared property which returns the dot product of the quaternion with itself
A Length property which returns the Square Root of LengthSquared
An Invert function inverts the Quaternion
a static Inverse functionmust be available but it returns the inverse rather than affecting the original
A Normalize function which normalizes the Quaternion
A static implemenation of this function must be available but returns the normalized Quaternion rather than affecting the original
A Concatenate function which takes another Quaternion and concatenates it with this quaternion
A static implementation of this functionmust be available but it returns a new Quaternion rather than affecting the originals
A Conjugate function which returns the conjugate of this quaternion
A static implementation of this functionmust be available
A static CreateFromAxisAngle function which takes in aVector3D<T> and an angle and returns a Quaternion representing that rotation
A static CreateFromRotationMatrix function which takes either a Matrix3X3 or Matrix4X4 and returns a Quaternion representing that rotation
A static CreateFromYawPitchRoll which takes either each components separately or in aVector3D<T> and outputs a Quaternion representing that rotation
A static Lerp function which takes 2 Quaternions and a Scalar matching the generic type which linearly interpolates between the 2 Quaternions with scalar used as the amount to lerp
A static SLerp function which takes 2 Quaternions and a Scalar matching the generic type which Spherical linearly interpolates between the 2 Quaternions with scalar used as the amount to lerp
A static Zero Quaternion Property
A static Identity Quaternion Property
Geometric Types:
Box2
Box3
Circle
Cube
Plane
Ray2
Ray3
Rectangle
Sphere
Geometric Types details:
Intersect functions with both another instance of the type and a point
GetDistanceToNearest(Point,Edge,etc) functionsmust be available for a given point
For all but the rays and planes, GetInflated function that takes a point and returns the scaled object that is closest to the original and contains the given point
Include Scale and Translation transformation functions
For Box and Rectangle the following Vector propertiesmust be defined
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading.Please reload this page.
Summary of the PR
Implements theGeneric Maths Proposal
Progress
Further Comments
Old Silk.NET.Maths classes are kept in a
Legacy/folder, this is just temporary and will be removed. If you'd like this to be split up into multiple smaller PRs let me know.