mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
lib/matrix: Remove method catalog [doc] [ci-skip]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60730 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
parent
6e3126d33d
commit
3527c863be
1 changed files with 2 additions and 104 deletions
106
lib/matrix.rb
106
lib/matrix.rb
|
@ -28,110 +28,8 @@ end
|
|||
#
|
||||
# The +Matrix+ class represents a mathematical matrix. It provides methods for creating
|
||||
# matrices, operating on them arithmetically and algebraically,
|
||||
# and determining their mathematical properties (trace, rank, inverse, determinant).
|
||||
#
|
||||
# == Method Catalogue
|
||||
#
|
||||
# To create a matrix:
|
||||
# * Matrix[*rows]
|
||||
# * Matrix.[](*rows)
|
||||
# * Matrix.rows(rows, copy = true)
|
||||
# * Matrix.columns(columns)
|
||||
# * Matrix.build(row_count, column_count, &block)
|
||||
# * Matrix.diagonal(*values)
|
||||
# * Matrix.scalar(n, value)
|
||||
# * Matrix.identity(n)
|
||||
# * Matrix.unit(n)
|
||||
# * Matrix.I(n)
|
||||
# * Matrix.zero(n)
|
||||
# * Matrix.row_vector(row)
|
||||
# * Matrix.column_vector(column)
|
||||
# * Matrix.empty(row_count, column_count)
|
||||
# * Matrix.hstack(*matrices)
|
||||
# * Matrix.vstack(*matrices)
|
||||
#
|
||||
# To access Matrix elements/columns/rows/submatrices/properties:
|
||||
# * #[](i, j)
|
||||
# * #row_count (row_size)
|
||||
# * #column_count (column_size)
|
||||
# * #row(i)
|
||||
# * #column(j)
|
||||
# * #collect
|
||||
# * #map
|
||||
# * #each
|
||||
# * #each_with_index
|
||||
# * #find_index
|
||||
# * #minor(*param)
|
||||
# * #first_minor(row, column)
|
||||
# * #cofactor(row, column)
|
||||
# * #adjugate
|
||||
# * #laplace_expansion(row_or_column: num)
|
||||
# * #cofactor_expansion(row_or_column: num)
|
||||
#
|
||||
# Properties of a matrix:
|
||||
# * #diagonal?
|
||||
# * #empty?
|
||||
# * #hermitian?
|
||||
# * #lower_triangular?
|
||||
# * #normal?
|
||||
# * #orthogonal?
|
||||
# * #permutation?
|
||||
# * #real?
|
||||
# * #regular?
|
||||
# * #singular?
|
||||
# * #square?
|
||||
# * #symmetric?
|
||||
# * #unitary?
|
||||
# * #upper_triangular?
|
||||
# * #zero?
|
||||
#
|
||||
# Matrix arithmetic:
|
||||
# * #*(m)
|
||||
# * #+(m)
|
||||
# * #-(m)
|
||||
# * #/(m)
|
||||
# * #inverse
|
||||
# * #inv
|
||||
# * #**
|
||||
# * #+@
|
||||
# * #-@
|
||||
#
|
||||
# Matrix functions:
|
||||
# * #determinant
|
||||
# * #det
|
||||
# * #hstack(*matrices)
|
||||
# * #rank
|
||||
# * #round
|
||||
# * #trace
|
||||
# * #tr
|
||||
# * #transpose
|
||||
# * #t
|
||||
# * #vstack(*matrices)
|
||||
#
|
||||
# Matrix decompositions:
|
||||
# * #eigen
|
||||
# * #eigensystem
|
||||
# * #lup
|
||||
# * #lup_decomposition
|
||||
#
|
||||
# Complex arithmetic:
|
||||
# * conj
|
||||
# * conjugate
|
||||
# * imag
|
||||
# * imaginary
|
||||
# * real
|
||||
# * rect
|
||||
# * rectangular
|
||||
#
|
||||
# Conversion to other data types:
|
||||
# * #coerce(other)
|
||||
# * #row_vectors
|
||||
# * #column_vectors
|
||||
# * #to_a
|
||||
#
|
||||
# String representations:
|
||||
# * #to_s
|
||||
# * #inspect
|
||||
# and determining their mathematical properties such as trace, rank, inverse, determinant,
|
||||
# or eigensystem.
|
||||
#
|
||||
class Matrix
|
||||
include Enumerable
|
||||
|
|
Loading…
Reference in a new issue