numerix 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 466136197ebd04c9c5daeb6b6eafdcfebc5788e8
+  data.tar.gz: 9c5162a141745a2c3a0ab1cb1429c2bcf563e317
+SHA512:
+  metadata.gz: 7e69b9ab91b0787cd16bfaf2e379e0e0648e6efac52681986b80b81e58921d70f9b350274c0e18e1ea464576c407705f6d80b8421216487b7d0a1689a17b9642
+  data.tar.gz: 037dabaa658ae2d6a286ff1de482071afae69f915f8cb8bf5b1ff6a25aeed0fbc4824d5054a41c789a819c2e834959ba91a3a12e6e8adc6f35d9166e67bd196b

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/test/
+/spec/reports/
+/tmp/
+*.gem
+*.bundle
+*.so
+*.o
+*.a
+/.vscode
+.idea
+*.cs
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.2

data/.yardopts

@@ -0,0 +1,5 @@
+--readme README.md
+--title 'Numerix Documentation'
+--charset utf-8
+--markup markdown
+lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at efreed09@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in numerix.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Eric Freed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+
+# ![logo](./extra/numerix32.png)  Numerix
+
+Numerix is a powerful and feature-rich Ruby C-extension for working with vectors and matrices. 
+
+The vector and matrix classes that are part of Ruby's standard library are implemented purely as Ruby code, and lack anything beyond the most basic function. Numerix strives to make working with vectors more "Ruby-like", and far exceeds Ruby's built-in implementations many times over in regards to speed and performance.
+
+Great care has been take to make the library "interop" friendly, where each class can easily be passed as a "pointer" or binary string for interop with native libraries, using Ruby's `Fiddle`, FFI, or even Ruby's legacy `Win32API`. Numerix has been built from the ground-up for Ruby, not playing middle-man between Ruby and an existing library, and is optimized specifically for it, with focus on speed and a robust collection of functionality.
+
+This is my first publicly released C extension for Ruby, and I welcome bug reports of any kind, in addition to feature requests, and ALL constructive feedback. Please don't hesitate to report any issues [on GitHub](https://github.com/ForeverZer0/numerix/issues)!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'numerix'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install numerix
+
+## Usage
+
+Numerix was based strongly off the `System.Numerics` library of Microsoft's .NET Framework (the inspiration behind the name), and contains the minimum set of functions and classes that are within it, in addition to many more. 
+
+The following base classes are implemented completeley, and all work together to form a unified experience.
+
+* **Vector2** - A structure encapsulating two single precision floating point values (_x, y_)
+* **Vector3** - A structure encapsulating three single precision floating point values (_x, y, z_)
+* **Vector4** - A structure encapsulating four single precision floating point values (_x, y, z, w_)
+* **Matrix3x2** - A structure encapsulating a 3x2 matrix
+* **Matrix4x4** - A structure encapsulating a 4x4 matrix
+* **Plane** - A structure encapsulating a 3D plane (Vector3 denoting _normal_ and a float for _distance_)
+* **Quaternion** - A structure encapsulating four single precision floating point values (_x, y, z, w_)
+
+In addition to the "core" classes, there is a basic `Vector` class that is an analog to the standard library's `Vector` class, but implemented in `C`. This class allows for arbitrary sized vectors same as its Ruby analog, but is not as optmized or feature-rich as is possible with the fixed-size vector classes.  
+
+For each method (where applicable), there is typically a standard "pure" method, and "impure" variation that alters the object's state. All of the impure methods follow the standard Ruby convention of being suffixed with a `!`.
+
+```ruby
+# Create a vector with 3 elements
+vec3 = Vector3.new(5.0, 4.0, 9.0)
+
+norm = vec3.normalize
+vec3.normalize!
+```
+
+There is a host of methods available for each class, which are outlined in detail within the documentation, and excompass all that would be expected of any vector/matrix library, and additionally many "helper" functions to efficiently perform many common and less-common operations. All of these functions are implemented the "Ruby-way", following standard Ruby style and syntax.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ForeverZer0/numerix. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Numerix project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ForeverZer0/numerix/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("numerix") do |ext|
+  ext.lib_dir = "lib/numerix"
+end
+
+task :default => [:clobber, :compile, :test]

data/TODO.txt

@@ -0,0 +1,25 @@
+
+
+fix equality checking (consistent)
+
+
+coerce  Ruby Vector, Matrix, Pointer, etc 
+
+
+DOCUMENTE ** function in matrix classes !!!!!!!!!!!
+
+MOVE ** from VectorBase to individual vector classes and document
+
+[equiv, self]
+
+
+RANGE ERRORS IN MATRIX CLASS(ES)
+
+
+//////////////// PLANE /////////////////////////////
+// to_a, to_h
+// to_vec4
+// normalize, !
+// dot
+// dot_coord
+// dot_normal

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "numerix"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/numerix/common.h

@@ -0,0 +1,107 @@
+#ifndef NUMERIX_COMMON_H
+#define NUMERIX_COMMON_H 1
+
+#include "ruby.h"
+
+#define NUMERIX_MIN(a, b) (a < b ? a : b)
+#define NUMERIX_MAX(a, b) (a > b ? a : b)
+#define NUMERIX_CLAMP(value, min, max) (value < min ? min : value > max ? max : value)
+
+#define NUMERIX_TYPE_P(obj, klass) (rb_obj_is_kind_of(obj, klass) == Qtrue)
+#define NUMERIX_INHERIT_P(klass, super) (rb_class_inherited_p(klass, super) == Qtrue)
+
+#define NUMERIX_PI 3.141593f
+#define NUMERIX_HALF_PI 1.570796f
+
+#define NUM2FLT(value) ((float)rb_num2dbl(value))
+#define NUMERIX_WRAP(klass, ptr) Data_Wrap_Struct(klass, NULL, RUBY_DEFAULT_FREE, ptr)
+
+#define CLASS_NAME(obj) rb_class2name(CLASS_OF(obj))
+
+#define FLT_EQUAL(a, b) fabsf(a - b) < FLT_EPSILON
+
+#define PRIVATE_CLASS_METHOD(klass, methodName) rb_funcall(klass, rb_intern("private_class_method"), 1, ID2SYM(rb_intern(methodName)))
+
+typedef struct Vector2 {
+    float x; /* The X component of the vector. */
+    float y; /* The Y component of the vector. */
+} Vector2;
+
+typedef struct Vector3 {
+    float x; /* The X component of the vector. */
+    float y; /* The Y component of the vector. */
+    float z; /* The Z component of the vector. */
+} Vector3;
+
+typedef struct Vector4 {
+    float x; /* The X component of the vector. */
+    float y; /* The Y component of the vector. */
+    float z; /* The Z component of the vector. */
+    float w; /* The W component of the vector. */
+} Vector4;
+
+typedef struct Quaternion {
+    float x; /* Specifies the X-value of the vector component of the Quaternion. */
+    float y; /* Specifies the Y-value of the vector component of the Quaternion. */
+    float z; /* Specifies the Z-value of the vector component of the Quaternion. */
+    float w; /* Specifies the rotation component of the Quaternion. */
+} Quaternion;
+
+typedef struct Plane {
+    Vector3 normal; /* The normal vector of the Plane. */
+    float distance; /* The distance of the Plane along its normal from the origin. */
+} Plane;
+
+typedef struct Matrix3x2 {
+    float m11; /* Value at row 1, column 1 of the matrix. */
+    float m12; /* Value at row 1, column 2 of the matrix. */
+
+    float m21; /* Value at row 2, column 1 of the matrix. */
+    float m22; /* Value at row 2, column 2 of the matrix. */
+
+    float m31; /* Value at row 3, column 1 of the matrix. */
+    float m32; /* Value at row 3, column 2 of the matrix. */
+} Matrix3x2;
+
+typedef struct Matrix4x4 {
+    float m11; /* Value at row 1, column 1 of the matrix. */
+    float m12; /* Value at row 1, column 2 of the matrix. */
+    float m13; /* Value at row 1, column 3 of the matrix. */
+    float m14; /* Value at row 1, column 4 of the matrix. */
+
+    float m21; /* Value at row 2, column 1 of the matrix. */
+    float m22; /* Value at row 2, column 2 of the matrix. */
+    float m23; /* Value at row 2, column 3 of the matrix. */
+    float m24; /* Value at row 2, column 4 of the matrix. */
+
+    float m31; /* Value at row 3, column 1 of the matrix. */
+    float m32; /* Value at row 3, column 2 of the matrix. */
+    float m33; /* Value at row 3, column 3 of the matrix. */
+    float m34; /* Value at row 3, column 4 of the matrix. */
+
+    float m41; /* Value at row 4, column 1 of the matrix. */
+    float m42; /* Value at row 4, column 2 of the matrix. */
+    float m43; /* Value at row 4, column 3 of the matrix. */
+    float m44; /* Value at row 4, column 4 of the matrix. */
+} Matrix4x4;
+
+typedef struct BasicVector {
+    int count;
+    float *values;
+} BasicVector;
+
+extern VALUE rb_numerix_abstract_initialize(VALUE self);
+extern VALUE rb_mNumerix;
+extern VALUE rb_eNumerixError;
+extern VALUE rb_cNumerixStruct;
+extern VALUE rb_cVectorBase;
+extern VALUE rb_cMatrixBase;
+extern VALUE rb_cVector2;
+extern VALUE rb_cVector3;
+extern VALUE rb_cVector4;
+extern VALUE rb_cMatrix3x2;
+extern VALUE rb_cMatrix4x4;
+extern VALUE rb_cQuaternion;
+extern VALUE rb_cPlane;
+
+#endif /* NUMERIX_COMMON_H */

data/ext/numerix/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("numerix/numerix")