Vectors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 057b69577336c488e83124f9e964953a840a2f5ef0ffca66b6679f6fa3fbdf71
+  data.tar.gz: 07d6e65221184002e719f666f94362b9b853bf20e7f81863bd3841d01435a32f
+SHA512:
+  metadata.gz: a36c6f8929dfa96ab6e87a751d464f1da3aba572f523cbc906c0c3019af98f3ca5958495a1129ffe4737e3fa06da0439ace9be1c34c76338a97b2c2682c31b88
+  data.tar.gz: 778bc0502f69da94e5a32749af1c3d9eda550dd8bb10989162ca17f0f26709302291884b743aafee2ca4bae1d267c9dfefb639818a491141d6c2ffba038fdfd0

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 inaidE
+
+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 @@
+# Vectors
+
+Vectors is a Ruby gem that provides essential functions for vector arithmetic and geometric computations. It includes methods for calculating determinants, scalar products, and cross products, making it a handy tool for projects that require linear algebra operations.
+
+## Installation
+Installation via Git:
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Vectors', git: 'https://github.com/inaidE/projectAVOCADOS'
+```
+Then run:
+bundle install
+
+Installation via RubyGems:
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add Vectors
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install Vectors
+```
+
+## Usage
+
+Determinant Calculation
+
+matrix = [
+  [1, 2],
+  [3, 4]
+]
+result = Vectors.Determinant(matrix)
+puts result # Output: -2
+
+Scalar Product
+
+a = [1, 2, 3]
+b = [4, 5, 6]
+result = Vectors.scalar_prod(a, b)
+puts result # Output: 32
+
+Cross Product
+
+a = [1, 2, 3]
+b = [4, 5, 6]
+result = Vectors.cross_prod(a, b)
+puts result.inspect # Output: [-3, 6, -3]
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/inaidE/projectAVOCADOS.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/Vectors/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vectors
+  VERSION = "0.1.0"
+end

data/lib/Vectors.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require_relative "Vectors/version"
+
+module Vectors
+  class Error < StandardError; end
+
+  extend self 
+
+  # input: matrix - Array of arrays size of nxn
+  # output: res[Int] - simple Integer
+  def Determinant(matrix)
+    raise TypeError, "Ожидался массив массивов" unless matrix.is_a?(Array) 
+
+    n = matrix.size
+
+    if n == 0 || !matrix.all? { |row| row.is_a?(Array) && row.size == n }
+        raise ArgumentError, "Матрица должна быть квадратной и непустой"
+    end
+
+    matrix.each do |row|
+        row.each do |el|
+            unless el.is_a?(Numeric)
+                 raise ArgumentError, "Все элементы матрицы должны быть числовыми"
+            end
+        end
+    end
+
+    if n == 1 
+        return matrix[0][0]
+    elsif n == 2 
+        return matrix[0][0] * matrix[1][1] - matrix[0][1] * matrix[1][0]
+    else
+        det = 0
+        matrix[0].each_with_index do |element, col|
+            minor = matrix[1..-1].map do |row|
+                row.reject.with_index { |_, index| index == col}
+            end
+            det += ((-1) ** col) * element * Determinant(minor)
+        end
+        return det
+    end
+  end
+
+
+  # input: a[Array], b[Array]- vectors a and b; 
+  # output: res[Int] - simple Integer as a result of scalar prod
+  def scalar_prod(a, b)
+    unless a.is_a?(Array) && b.is_a?(Array)
+      raise TypeError, "Вектора должны быть массивами"
+    end
+
+    unless a.size == b.size
+      raise ArgumentError, "Вектора должны иметь одинаковую длину"
+    end
+
+    return 0 if a.size == 0
+  
+    unless a.all? { |el| el.is_a?(Numeric) } && b.all? { |el| el.is_a?(Numeric) }
+      raise TypeError, "Вектора должны состоять из чисел"
+    end
+  
+    res = 0
+    [a, b].transpose.each { |x, y| res += x * y }
+  
+    res
+end
+
+  # input: a[Array], b[Array] - vectors a and b with dimension n = 3;
+  # output: res[Array] - vector with the size = 3 (its dimension) as a result of cross prod
+  def cross_prod(a, b)
+    raise TypeError, "Оба аргумента должны быть массивами" unless a.is_a?(Array) && b.is_a?(Array)
+    raise ArgumentError, "Векторы должны быть трехмерными" unless a.size == 3 && b.size == 3
+    raise TypeError, "Все элементы должны быть числами" unless a.all? { |x| x.is_a?(Numeric) } && b.all? { |x| x.is_a?(Numeric) }
+  
+    x_component = Determinant([
+      [a[1], a[2]],
+      [b[1], b[2]]
+    ])
+  
+    y_component = -Determinant([
+      [a[0], a[2]],
+      [b[0], b[2]]
+    ])
+  
+    z_component = Determinant([
+      [a[0], a[1]],
+      [b[0], b[1]]
+    ]) 
+  
+    [x_component, y_component, z_component]
+  end
+
+  # output - String with info about gem funcs
+  def help
+    puts <<~HELP
+      - Determinant(matrix)
+  
+        input: matrix - Array of arrays size of nxn
+        output: res[Int] - simple Integer
+  
+      - scalar_prod(a, b)
+  
+        input: a[Array], b[Array]- vectors a and b
+        output: res[Int] - simple Integer as a result of scalar prod
+  
+      - cross_prod(a, b)
+  
+        input: a[Array], b[Array] - vectors a and b with dimension n = 3;
+        output: res[Array] - vector with the size = 3 (its dimension) as a result of cross prod
+    HELP
+  end
+  
+
+  
+  
+end

data/sig/Vectors.rbs

@@ -0,0 +1,4 @@
+module Vectors
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: Vectors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- inaidE
+- spartanec22832
+- t1sh3
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-07 00:00:00.000000000 Z
+dependencies: []
+description: "A Ruby gem for vector and matrix operations. Provides methods to calculate:\n
+  \ - Matrix determinant:\n\n   Determinant(matrix)\n\n   input: matrix - Array of
+  arrays size of nxn\n   output: res[Int] - simple Integer\n\n  - Scalar product of
+  vectors\n\n  scalar_prod(a, b)\n\n  input: a[Array], b[Array]- vectors a and b\n
+  \ output: res[Int] - simple Integer as a result of scalar prod\n\n  - Cross product
+  for 3D vectors\n\n    cross_prod(a, b)\n\n    input: a[Array], b[Array] - vectors
+  a and b with dimension n = 3;\n    output: res[Array] - vector with the size = 3
+  (its dimension) as a result of cross prod\n\n  - Help function\n\n    help()\n\n
+  \   output: String with info about gem funcs\n  \n  Includes comprehensive error
+  handling and input validation. Designed for educational use and basic linear algebra
+  computations.\n\n  Ruby-гем для операций с векторами и матрицами. Предоставляет
+  методы для вычисления:\n  - Определителя матрицы\n\n    Determinant(matrix)\n\n
+  \   input: matrix - матрица (массив массивов) размера nxn\n    output: res[Int]
+  - целое число\n\n  - Скалярного произведения векторов\n\n    scalar_prod(a, b)\n\n
+  \   input: a[Array], b[Array] - векторы (массивы) a и b\n    output: res[Int] -
+  целое число как результат скалярного произведения\n\n  - Векторного произведения
+  для 3D векторов\n\n    cross_prod(a, b)\n\n    input: a[Array], b[Array] - векторы
+  (массивы) a и b размером n = 3;\n    output: res[Array] - вектор (массив) с размером
+  = 3 (его размерность) как результат векторного произведения векторов\n\n  - Функция
+  \"помощь\"\n\n    help()\n\n    output: Строка с информацией про математические
+  методы гема\n\n  Включает обработку ошибок и валидацию входных данных. Разработан
+  для образовательных целей и базовых вычислений линейной алгебры."
+email:
+- perminov@sfedu.ru
+- bogovskii@sfedu.ru
+- dantipov@sfedu.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/Vectors.rb
+- lib/Vectors/version.rb
+- sig/Vectors.rbs
+homepage: https://github.com/iginaidE/Vectors
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: 'Vectors: Linear Algebra Operations for calculating determinant, cross product
+  and scalar product | Векторы: Операции линейной алгебры для вычисления определителя,
+  векторного и скалярного произведений векторов'
+test_files: []