kxi 1.0.1 → 1.0.2

data/lib/kxi/exceptions/configuration_exception.rb

@@ -1,26 +1,37 @@
-# Created by Matyáš Pokorný on 2018-01-24.
-
-module KXI
-	module Exceptions
-		class ConfigurationException < Exception
-			def file
-				@file
-			end
-			
-			def path
-				@path
-			end
-			
-			def error_message
-				@msg
-			end
-			
-			def initialize(file, path, msg = nil)
-				super("Invalid configuration <#{path}> in file '#{file}'!#{msg != nil ? ": #{msg}" : ''}")
-				@file = file
-				@path = path
-				@msg = msg
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-24.
+
+module KXI
+	module Exceptions
+		# Raised on error during configuration file reading
+		class ConfigurationException < Exception
+			# Gets the path of the configuration file
+			# @return [string] Path of the configuration file
+			def file
+				@file
+			end
+			
+			# Gets the path of the configuration parameter
+			# @return [string] Path of the configuration parameter
+			def path
+				@path
+			end
+			
+			# Gets the message of error
+			# @return [string] Message of error
+			def error_message
+				@msg
+			end
+			
+			# Instantiates the {KXI::Exceptions::ConfigurationException} class
+			# @param [string] file Path of the configuration file
+			# @param [string] path Path of the configuration parameter
+			# @param [string,nil] msg Message of error
+			def initialize(file, path, msg = nil)
+				super("Invalid configuration <#{path}> in file '#{file}'!#{msg != nil ? ": #{msg}" : ''}")
+				@file = file
+				@path = path
+				@msg = msg
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/dimension_mismatch_exception.rb

@@ -0,0 +1,29 @@
+# Created by Matyáš Pokorný on 2018-04-14.
+
+module KXI
+	module Exceptions
+		# Raised when matrices or vectors are of incompatible dimensions during operation
+		class DimensionMismatchException < Exception
+			# Gets the expected dimension
+			# @return [integer] Expected dimension
+			def expected
+				@ex
+			end
+			
+			# Gets the actual dimension
+			# @return [integer] Actual dimension
+			def actual
+				@act
+			end
+			
+			# Instantiates the {KXI::Exceptions::DimensionMismatchException} class
+			# @param [integer] act Actual dimension
+			# @param [integer] ex Expected dimension
+			def initialize(act, ex)
+				@act = act
+				@ex  = ex
+				super("Expected dimension #{ex} got #{act}!")
+			end
+		end
+	end
+end

data/lib/kxi/exceptions/invalid_type_exception.rb

@@ -1,33 +1,33 @@
-# Created by Matyáš Pokorný on 2017-12-30.
-
-module KXI
-	module Exceptions
-		# Raised when some value is of unexpected type
-		class InvalidTypeException < Exception
-			# Returns expected types
-			# @return [Array<Class>] Expected types
-			def expected
-				@exp
-			end
-			
-			# Returns actual type
-			# @return [Class] Actual type
-			def actual
-				@act
-			end
-			
-			# Instantiates the [KXI::Exceptions::InvalidTypeException] class
-			# @param exp [Array<Class>] Expected types
-			# @param act [Class] Actual type
-			def initialize(act, *exp)
-				if exp.length == 1
-					super("Value is of unexpected type! Expected <#{exp[0].name}> got <#{act.name}>")
-				else
-					super("Value is of unexpected type! Expected { #{exp.collect {|i| "<#{i}>"}.join(', ')} } got <#{act.name}>")
-				end
-				@exp = exp
-				@act = act
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-30.
+
+module KXI
+	module Exceptions
+		# Raised when some value is of unexpected type
+		class InvalidTypeException < Exception
+			# Returns expected types
+			# @return [Array<Class>] Expected types
+			def expected
+				@exp
+			end
+			
+			# Returns actual type
+			# @return [Class] Actual type
+			def actual
+				@act
+			end
+			
+			# Instantiates the [KXI::Exceptions::InvalidTypeException] class
+			# @param exp [Array<Class>] Expected types
+			# @param act [Class] Actual type
+			def initialize(act, *exp)
+				if exp.length == 1
+					super("Value is of unexpected type! Expected <#{exp[0].name}> got <#{act.name}>")
+				else
+					super("Value is of unexpected type! Expected { #{exp.collect {|i| "<#{i}>"}.join(', ')} } got <#{act.name}>")
+				end
+				@exp = exp
+				@act = act
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/no_argument_exception.rb

@@ -1,21 +1,21 @@
-# Created by Matyáš Pokorný on 2018-01-21.
-
-module KXI
-	module Exceptions
-		# Raised when argument value has no binding argument
-		class NoArgumentException < Exception
-			# Gets the erroneous value
-			# @return [String] Erroneous value
-			def value
-				@val
-			end
-			
-			# Instantiates the {KXI::Exceptions::NoArgumentException} class
-			# @param val [String] Erroneous value
-			def initialize(val)
-				super("Value '#{val}' has no argument to bind to!")
-				@val = val
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-21.
+
+module KXI
+	module Exceptions
+		# Raised when argument value has no binding argument
+		class NoArgumentException < Exception
+			# Gets the erroneous value
+			# @return [String] Erroneous value
+			def value
+				@val
+			end
+			
+			# Instantiates the {KXI::Exceptions::NoArgumentException} class
+			# @param val [String] Erroneous value
+			def initialize(val)
+				super("Value '#{val}' has no argument to bind to!")
+				@val = val
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/not_implemented_exception.rb

@@ -1,13 +1,13 @@
-# Created by Matyáš Pokorný on 2017-12-29.
-
-module KXI
-	module Exceptions
-		# Raised when given part of code isn't yet implemented
-		class NotImplementedException < Exception
-			# Instantiates the {KXI::Exceptions::NotImplementedException} class
-			def initialize
-				super('Code not implemented yet!')
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-29.
+
+module KXI
+	module Exceptions
+		# Raised when given part of code isn't yet implemented
+		class NotImplementedException < Exception
+			# Instantiates the {KXI::Exceptions::NotImplementedException} class
+			def initialize
+				super('Code not implemented yet!')
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/out_of_range_exception.rb

@@ -1,44 +1,44 @@
-# Created by Matyáš Pokorný on 2017-12-29.
-
-module KXI
-	module Exceptions
-		# Raised when certain value is out of range
-		class OutOfRangeException < Exception
-			# Returns erroneous value
-			# @return [Object] Erroneous value
-			def value
-				@val
-			end
-			
-			# Returns minimal expected value
-			# @return [Object, nil] Minimal expected value; nil if there is no minimum
-			def minimum
-				@min
-			end
-			
-			# Returns maximal expected value
-			# @return [Object, nil] Maximal expected value; nil if there is no maximum
-			def maximum
-				@max
-			end
-			
-			# Instantiates the {KXI::Exceptions::OutOfRangeException} class
-			# @param val [Object] Erroneous value
-			# @param min [Object, nil] Minimal expected value; nil if there is no minimum
-			# @param max [Object, nil] Maximal expected value; nil if there is no maximum
-			# @note If both min and max are nil, then range is empty set
-			def initialize(val, min = nil, max = nil)
-				if min == nil and max == nil
-					super("Value '#{val}' is out of range {}!")
-				elsif min == max
-					super("Value '#{val}' is out of range {#{min}}!")
-				else
-					super("Value '#{val}' is out of range #{(min == nil ? '(-∞' : "<#{min}")};#{(max == nil ? '∞)' : "#{max}>")}!")
-				end
-				@val = val
-				@min = min
-				@max = max
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-29.
+
+module KXI
+	module Exceptions
+		# Raised when certain value is out of range
+		class OutOfRangeException < Exception
+			# Returns erroneous value
+			# @return [Object] Erroneous value
+			def value
+				@val
+			end
+			
+			# Returns minimal expected value
+			# @return [Object, nil] Minimal expected value; nil if there is no minimum
+			def minimum
+				@min
+			end
+			
+			# Returns maximal expected value
+			# @return [Object, nil] Maximal expected value; nil if there is no maximum
+			def maximum
+				@max
+			end
+			
+			# Instantiates the {KXI::Exceptions::OutOfRangeException} class
+			# @param val [Object] Erroneous value
+			# @param min [Object, nil] Minimal expected value; nil if there is no minimum
+			# @param max [Object, nil] Maximal expected value; nil if there is no maximum
+			# @note If both min and max are nil, then range is empty set
+			def initialize(val, min = nil, max = nil)
+				if min == nil and max == nil
+					super("Value '#{val}' is out of range {}!")
+				elsif min == max
+					super("Value '#{val}' is out of range {#{min}}!")
+				else
+					super("Value '#{val}' is out of range #{(min == nil ? '(-∞' : "<#{min}")};#{(max == nil ? '∞)' : "#{max}>")}!")
+				end
+				@val = val
+				@min = min
+				@max = max
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/parse_exception.rb

@@ -1,21 +1,29 @@
-# Created by Matyáš Pokorný on 2018-01-27.
-
-module KXI
-	module Exceptions
-		class ParseException < Exception
-			def value
-				@val
-			end
-			
-			def parser
-				@par
-			end
-			
-			def initialize(parser, val)
-				super("Failed to parse value '#{val.to_s}' as #{parser}!")
-				@par = parser
-				@val = val
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-27.
+
+module KXI
+	module Exceptions
+		# Raised when parser encounters an error
+		class ParseException < Exception
+			# Get the parsed value
+			# @return [any] Parsed value
+			def value
+				@val
+			end
+			
+			# Gets the name of the parser
+			# @return [string] Name of the parser
+			def parser
+				@par
+			end
+			
+			# Instantiates the {KXI::Exceptions::ParseException} class
+			# @param [string] parser Name of the parser
+			# @param [any] val Parsed value
+			def initialize(parser, val)
+				super("Failed to parse value '#{val.to_s}' as #{parser}!")
+				@par = parser
+				@val = val
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/verb_expected_exception.rb

@@ -1,21 +1,21 @@
-# Created by Matyáš Pokorný on 2018-01-21.
-
-module KXI
-	module Exceptions
-		# Raised when specific verb was expected
-		class VerbExpectedException < Exception
-			# Gets array of verbs that were expected
-			# @return [Array<String>] Expected verbs
-			def verbs
-				@verbs
-			end
-			
-			# Instantiates the {KXI::CLI::VerbExpectedException} class
-			# @param verbs [Array<String>] Expected verbs
-			def initialize(verbs)
-				super("Expected verb! (#{verbs.join(', ')})")
-				@verbs = verbs
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-21.
+
+module KXI
+	module Exceptions
+		# Raised when specific verb was expected
+		class VerbExpectedException < Exception
+			# Gets array of verbs that were expected
+			# @return [Array<String>] Expected verbs
+			def verbs
+				@verbs
+			end
+			
+			# Instantiates the {KXI::CLI::VerbExpectedException} class
+			# @param verbs [Array<String>] Expected verbs
+			def initialize(verbs)
+				super("Expected verb! (#{verbs.join(', ')})")
+				@verbs = verbs
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/workspace_collision_exception.rb

@@ -0,0 +1,21 @@
+# Created by Matyáš Pokorný on 2018-03-23.
+
+module KXI
+	module Exceptions
+		# Raised when part of workspace path is a file
+		class WorkspaceCollisionException < Exception
+			# Gets the path of workspace
+			# @return [string] Path of workspace
+			def path
+				@path
+			end
+			
+			# Instantiates the {KXI::Exceptions::WorkspaceCollisionException} class
+			# @param [string] path Path of workspace
+			def initialize(path)
+				super("Workspace path '#{path}' is used by file!")
+				@path = path
+			end
+		end
+	end
+end

data/lib/kxi/math/math.rb

@@ -0,0 +1,45 @@
+# Created by Matyáš Pokorný on 2018-04-12.
+
+module KXI
+	module Math
+		# Computes factorial
+		# @param [Integer] n Factorial base
+		# @return [Integer] Value of factorial
+		def self.fact(n)
+			n <= 0 ? 1 : n * fact(n - 1)
+		end
+		
+		def self.lfact(n, l)
+			return (l == 1 or n <= 0) ? n : n * lfact(n - 1, l - 1)
+		end
+		
+		# Computes fraction of factorials (!n / !m)
+		# @param [Integer] n Factorial base of numerator
+		# @param [Integer] m Factorial base of denominator
+		# @return [Numeric] Result of fraction
+		def self.pfact(n, m)
+			return 1 if n == m
+			return (1.to_f / lfact(m, m - n)) if m > n
+			return lfact(n, n - m)
+		end
+		
+		# Computes the binomial coefficient
+		# @param [Integer] n First (upper) term of coefficient
+		# @param [Integer] k Second (lower) term of coefficient
+		# @return [Numeric] Binomial coefficient (n choose k)
+		def self.choose(n, k)
+			return pfact(n, k) / fact(n - k)
+		end
+		
+		# Computes the permutation of two numbers
+		# @param [Integer] n First term of permutation
+		# @param [Integer] k Second term of permutation
+		# @return [Numeric] Permutation (k-permutations of n)
+		def self.permutation(n, k)
+			return 0 if k > n
+			pfact(n, n - k)
+		end
+		
+		private_class_method :lfact
+	end
+end