kxi 1.0.1 → 1.0.2

data/lib/kxi/math/vector.rb

@@ -0,0 +1,181 @@
+# Created by Matyáš Pokorný on 2018-04-14.
+
+module KXI
+	module Math
+		# Represents a vector
+		class Vector
+			# Returns the dimension of vector
+			# @return [Integer] Dimension of vector
+			def dimension
+				@dim
+			end
+			
+			# Instantiates the {KXI::Math::Vector} class
+			# @param [Integer] dim Dimension of vector
+			# @yield [d] Generator function
+			# @yieldparam Dimension to generate
+			# @yieldreturn [Numeric] Result of generator
+			# @raise [KXI::Exceptions::InvalidTypeException] When generator function returns value of invalid type
+			def initialize(dim)
+				@dim = dim
+				if block_given?
+					@data = []
+					dim.times do |d|
+						val = yield(d)
+						raise(KXI::Exceptions::InvalidTypeException.new(val.type, Numeric)) unless val.is_a?(Numeric)
+						@data.push(val.to_f)
+					end
+				else
+					@data = [0.0] * dim
+				end
+			end
+			
+			def str(num)
+				return (num == num.to_i ? num.to_i : num).to_s
+			end
+			
+			# Gets the value of vector at specific dimension
+			# @param [Integer] idx Dimension to return
+			# @raise [KXI::Exceptions::OutOfRangeException] When dimension is out of range
+			# @return [Numeric] Value of vector at given dimension
+			def [](idx)
+				raise(KXI::Exceptions::OutOfRangeException.new(idx, 0, @dim - 1)) if idx < 0 or idx >= @dim
+				raise(KXI::Exceptions::InvalidTypeException.new(value.type, Numeric)) unless value.is_a?(Numeric)
+				return @data[idx]
+			end
+			
+			# Sets the value of vector at specific dimension
+			# @overload []=(idx, val)
+			# 	Sets the value of vector at specific dimension
+			# 	@param [Integer] idx Dimension to set
+			# 	@param [Integer] val Value to set the dimension to
+			# 	@raise [KXI::Exceptions::OutOfRangeException] When dimension is out of range
+			# 	@raise [KXI::Exceptions::InvalidTypeException] When value has invalid type
+			# 	@return [Numeric] Value passed to function
+			# @overload []=(idx, val)
+			# 	Sets the values of vector to range of values starting from specific dimension
+			# 	@param [Integer] idx Dimension to start at
+			# 	@param [Array] val Values to set the dimensions to
+			# 	@raise [KXI::Exceptions::OutOfRangeException] When dimension is out of range
+			# 	@raise [KXI::Exceptions::InvalidTypeException] When value has invalid type
+			# 	@return [Numeric] Value passed to function
+			def []=(idx, val)
+				raise(KXI::Exceptions::OutOfRangeException.new(idx, 0, @dim - 1)) if idx < 0 or idx >= @dim
+				if val.is_a?(Numeric)
+					@data[idx] = val.to_f
+				elsif val.is_a?(Array)
+					i = 0
+					while idx + i < @dim and i < val.length
+						v = val[i]
+						raise(KXI::Exceptions::InvalidTypeException.new(v.type, Numeric)) unless v.is_a?(Numeric)
+						@data[idx + i] = v.to_f
+					end
+				else
+					raise(KXI::Exceptions::InvalidTypeException.new(val.type, Numeric, Array))
+				end
+				return val
+			end
+			
+			# Iterates over each element of vector
+			# @yield [d, val] Iterator function
+			# @yieldparam [Integer] d Dimension passed to iterator
+			# @yieldparam [Numeric] val Value at that specific dimension
+			def each
+				return unless block_given?
+				@dim.times do |d|
+					yield(d, @data[d])
+				end
+			end
+			
+			# Dot multiplies vectors
+			# @param [KXI::Math::Vector] vec Vector to multiply with
+			# @return [Numeric] Dot product of vectors
+			def dot(vec)
+				raise(KXI::Exception::DimensionMismatchException.new(vec.dimension, dimension)) unless vec.dimension == dimension
+				sum = 0
+				@dim.times { |d| sum += @data[d] * vec[d] }
+				return sum
+			end
+			
+			# Converts vector to string
+			# @param [Boolean] d Determines whether string should be decorated
+			# @return [String] String representation of vector
+			def to_s(d = true)
+				just = 0
+				@dim.times { |m| len = str(@data[m]).length; just = len if len > just }
+				ret = ''
+				@dim.times do |m|
+					ret += $/ if m > 0
+					ret += '|' if d
+					ret += str(@data[m]).rjust(just, ' ')
+					ret += '|' if d
+				end
+				return ret
+			end
+			
+			# Adds vectors
+			# @param [Vector] other Vector to add
+			# @raise [KXI::Exceptions::InvalidTypeException] When type of value is invalid
+			# @return [KXI::Math::Vector] New vector equivalent to the sum of vectors
+			def +(other)
+				if other.is_a?(KXI::Math::Vector)
+					return KXI::Math::Vector.new(@dim) { |d| @data[d] + other[d] }
+				else
+					raise(KXI::Exceptions::InvalidTypeException.new(other.class, Numeric))
+				end
+			end
+			
+			# Subtracts vectors
+			# @param [Vector] other Vector to subtract
+			# @raise [KXI::Exceptions::InvalidTypeException] When type of value is invalid
+			# @return [KXI::Math::Vector] New vector equivalent to the difference of vectors
+			def -(other)
+				if other.is_a?(KXI::Math::Vector)
+					return KXI::Math::Vector.new(@dim) { |d| @data[d] - other[d] }
+				else
+					raise(KXI::Exceptions::InvalidTypeException.new(other.class, Numeric))
+				end
+			end
+			
+			# Multiplies the vector with -1
+			# @return [KXI::Math::Vector] New opposite vector
+			def -@
+				return KXI::Math::Vector.new(@dim) { |d| -@data[d] }
+			end
+			
+			# Multiplies vector
+			# @overload *(other)
+			# 	Preforms scalar-vector multiplication
+			# 	@param [Numeric] other Scalar to multiply with
+			# 	@raise [KXI::Exceptions::InvalidTypeException] When other value is of invalid type
+			# 	@return [KXI::Math::Vector] New vector equivalent to the scaled vector
+			# @overload *(other)
+			# 	Preforms vector-vector multiplication
+			# 	@param [Numeric] other Vector to multiply with
+			# 	@raise [KXI::Exceptions::InvalidTypeException] When other value is of invalid type
+			# 	@return [KXI::Math::Vector] New vector equivalent to the multiplied vector
+			def *(other)
+				if other.is_a?(Numeric)
+					return KXI::Math::Vector.new(@dim) { |d| other * @data[d] }
+				elsif other.is_a?(KXI::Math::Vector)
+					return KXI::Math::Vector.new(@dim) { |d| @data[d] * other[d] }
+				elsif raise(KXI::Exceptions::InvalidTypeException.new(other.class, Numeric, KXI::Math::Vector))
+				end
+			end
+			
+			# Compares vector
+			# @param [void] other Value to compare to
+			# @return [Boolean] True if vector is equivalent to given value; false otherwise
+			def ==(other)
+				return false unless other.is_a?(KXI::Math::Vector)
+				return false if @dim != other.dimension
+				@dim.times do |d|
+					return false if @data[d] != other[d]
+				end
+				return true
+			end
+			
+			private :str
+		end
+	end
+end

data/lib/kxi/platform.rb

@@ -1,58 +1,104 @@
-# Created by Matyáš Pokorný on 2018-01-28.
-
-module KXI
-	class Platform
-		def name
-			@name
-		end
-		
-		def version
-			@version
-		end
-		
-		def library_extensions
-			@libs
-		end
-		
-		def path_separator
-			@ps
-		end
-		
-		def initialize(nm, ver, ps, *libs)
-			@name    = nm
-			@version = KXI::Application::Version.parse(ver)
-			@ps      = ps
-			@libs    = libs
-		end
-		
-		def self.this
-			if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
-				return Platform.new('windows', `wmic os get Version /value`.split('=').last.strip.chomp, ';', 'dll')
-			elsif /darwin/ =~ RUBY_PLATFORM
-				return Platform.new('osx', `defaults read loginwindow SystemVersionStampAsString`, ':', 'dylib')
-			else
-				return Platform.new('linux', `uname -r`.split('-')[0], ':', 'so')
-			end
-		end
-		
-		def exec(name, *dir)
-			dir = Platform.env('path').split(@ps) if dir.length == 0
-			ext = Platform.env('pathext')
-			(ext != nil ? ext.split(@ps) + [''] : ['']).each do |e|
-				dir.each do |d|
-					f = File.join(d, "#{name}#{e}")
-					return f if File.exists?(f)
-				end
-			end
-			return nil
-		end
-		
-		def self.env(key)
-			key = key.downcase
-			ENV.each_pair do |k, v|
-				return v if k.downcase == key
-			end
-			return nil
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-28.
+
+module KXI
+	# Represents an platform of execution
+	class Platform
+		@@this = nil
+		# Microsoft Windows
+		WINDOWS = 'windows'
+		# Apple macOS
+		OSX = 'osx'
+		# Linux-based system
+		LINUX = 'linux'
+		
+		# Gets the name of platform
+		# @return [string] Name of platform
+		def name
+			@name
+		end
+		
+		# Gets the version of platform
+		# @return [KXI::Application::Version] Version of platform
+		def version
+			@version
+		end
+		
+		# Gets the file extensions of libraries
+		# @return [Array<string>] File extensions of libraries
+		def library_extensions
+			@libs
+		end
+		
+		# Gets the separator of paths
+		# @return [string] Separator of paths
+		def path_separator
+			@ps
+		end
+		
+		# Gets the separator of directories within a path
+		# @return [string] Separator of directories
+		def directory_separator
+			@ds
+		end
+		
+		# Determines whether paths are case-sensitive
+		# @return [bool] True if paths are case-sensitive; false otherwise
+		def path_case_sensitive?
+			@cs
+		end
+		
+		# Instantiates the {KXI::Platform} class
+		# @param [string] nm Name of platform
+		# @param [string] ver Version of platform
+		# @param [string] ds Directory separator
+		# @param [string] ps Path separator
+		# @param [string] cs Determines whether paths are case-sensitive
+		# @param [string] libs File extensions of libraries
+		def initialize(nm, ver, ds, ps, cs, *libs)
+			@name    = nm
+			@version = KXI::Application::Version.parse(ver)
+			@ds      = ds
+			@ps      = ps
+			@cs      = cs
+			@libs    = libs
+		end
+		
+		# Gets the current platform
+		# @return [KXI::Platform] Current platform
+		def self.this
+			return @@this if @@this != nil
+			if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
+				@@this = Platform.new(WINDOWS, `wmic os get Version /value`.split('=').last.strip.chomp, '\\', ';', false, 'dll')
+			elsif /darwin/ =~ RUBY_PLATFORM
+				@@this = Platform.new(OSX, `defaults read loginwindow SystemVersionStampAsString`, '/', ':', true, 'dylib')
+			else
+				@@this = Platform.new(LINUX, `uname -r`.split('-')[0], '/', ':', true, 'so')
+			end
+			return @@this
+		end
+		
+		# Finds an executable within the PATH of platform
+		# @return [string,nil] Path of executable if found; otherwise nil
+		def exec(name, *dir)
+			dir = Platform.env('path').split(@ps) if dir.length == 0
+			ext = Platform.env('pathext')
+			(ext != nil ? ext.split(@ps) + [''] : ['']).each do |e|
+				dir.each do |d|
+					f = File.join(d, "#{name}#{e}")
+					return f if File.exists?(f)
+				end
+			end
+			return nil
+		end
+		
+		# Gets an environment variable
+		# @return [string] Value of environment variable if found; otherwise nil
+		def self.env(key)
+			key = key.downcase
+			ENV.each_pair do |k, v|
+				return v if k.downcase == key
+			end
+			return nil
+		end
+	end
 end

data/lib/kxi/reflection/stack_frame.rb

@@ -1,81 +1,81 @@
-# Created by Matyáš Pokorný on 2017-12-28.
-module KXI
-	module Reflection
-		# Represents frame of call stack
-		class StackFrame
-			# Returns the file of frame
-			# @return [String] File of frame
-			def file
-				@file
-			end
-			
-			# Returns the line number of frame
-			# @return [Number] Line number of frame
-			def line
-				@line
-			end
-			
-			# Returns the context of frame
-			# @return [String] Context of frame
-			def context
-				@context
-			end
-			
-			# Indicates whether frame is block
-			# @return [Bool] True if stack frame represents call to block; false otherwise
-			def block?
-				@block != nil
-			end
-			
-			# Returns containing method of frame; nil if none
-			# @return [String, nil] Name of method that the stack frame represents
-			def method
-				return nil if @block != nil and @block[0] == '<' and @block[@block.length - 1] == '>'
-				return @block unless @block == nil
-				return nil if @context != nil and @context[0] == '<' and @context[@context.length - 1] == '>'
-				@context
-			end
-			
-			# Instantiates the {KXI::Reflection::StackFrame} class
-			# @param file [String] File of frame
-			# @param line [Number] Line number of frame
-			# @param context [String, nil] Context of frame
-			def initialize(file, line, context = nil)
-				@file    = file
-				@line    = line
-				@context = context
-				if context == nil
-					@block = nil
-				else
-					mt     = /^block (\((?'levels'\d+) levels\) )?in (?'method'.+)$/mi.match(context)
-					@block = mt == nil ? nil : mt['method']
-				end
-			end
-			
-			# Converts class to string
-			# @return [String] Equivalent string
-			def to_s
-				"#{@file}:#{@line}#{(@context != nil ? ": in `#{@context}'" : '')}"
-			end
-			
-			# Parses callstack into array of {KXI::Reflection::StackFrame}
-			# @param skip [Number] Number of callstack records to ignore
-			# @return [Array<KXI::Reflection::StackFrame>] Equivalent array of stack frames
-			def self.callstack(skip = 1)
-				ret = []
-				caller(skip).each do |bt|
-					ret.push(from_backtrace(bt))
-				end
-				return ret
-			end
-			
-			# Parses backtrace line into {KXI::Reflection::StackFrame}
-			# @param bt [String] Backtrace line
-			# @return [KXI::Reflection::StackFrame] Equivalent stack frame
-			def self.from_backtrace(bt)
-				mt = /(?'file'.+?):(?'line'\d+)(:\s*in\s*`(?'context'.+?)')?/.match(bt)
-				StackFrame.new(mt['file'], mt['line'].to_i, mt['context'])
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-28.
+module KXI
+	module Reflection
+		# Represents frame of call stack
+		class StackFrame
+			# Returns the file of frame
+			# @return [String] File of frame
+			def file
+				@file
+			end
+			
+			# Returns the line number of frame
+			# @return [Number] Line number of frame
+			def line
+				@line
+			end
+			
+			# Returns the context of frame
+			# @return [String] Context of frame
+			def context
+				@context
+			end
+			
+			# Indicates whether frame is block
+			# @return [Bool] True if stack frame represents call to block; false otherwise
+			def block?
+				@block != nil
+			end
+			
+			# Returns containing method of frame; nil if none
+			# @return [String, nil] Name of method that the stack frame represents
+			def method
+				return nil if @block != nil and @block[0] == '<' and @block[@block.length - 1] == '>'
+				return @block unless @block == nil
+				return nil if @context != nil and @context[0] == '<' and @context[@context.length - 1] == '>'
+				@context
+			end
+			
+			# Instantiates the {KXI::Reflection::StackFrame} class
+			# @param file [String] File of frame
+			# @param line [Number] Line number of frame
+			# @param context [String, nil] Context of frame
+			def initialize(file, line, context = nil)
+				@file    = file
+				@line    = line
+				@context = context
+				if context == nil
+					@block = nil
+				else
+					mt     = /^block (\((?'levels'\d+) levels\) )?in (?'method'.+)$/mi.match(context)
+					@block = mt == nil ? nil : mt['method']
+				end
+			end
+			
+			# Converts class to string
+			# @return [String] Equivalent string
+			def to_s
+				"#{@file}:#{@line}#{(@context != nil ? ": in `#{@context}'" : '')}"
+			end
+			
+			# Parses callstack into array of {KXI::Reflection::StackFrame}
+			# @param skip [Number] Number of callstack records to ignore
+			# @return [Array<KXI::Reflection::StackFrame>] Equivalent array of stack frames
+			def self.callstack(skip = 1)
+				ret = []
+				caller(skip).each do |bt|
+					ret.push(from_backtrace(bt))
+				end
+				return ret
+			end
+			
+			# Parses backtrace line into {KXI::Reflection::StackFrame}
+			# @param bt [String] Backtrace line
+			# @return [KXI::Reflection::StackFrame] Equivalent stack frame
+			def self.from_backtrace(bt)
+				mt = /(?'file'.+?):(?'line'\d+)(:\s*in\s*`(?'context'.+?)')?/.match(bt)
+				StackFrame.new(mt['file'], mt['line'].to_i, mt['context'])
+			end
+		end
+	end
 end