Skip to content

Commit cb6221b

Browse files
committed
fix docs
1 parent 8310878 commit cb6221b

File tree

3 files changed

+4
-12
lines changed

3 files changed

+4
-12
lines changed

Diff for: README

+1-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Linalg - Ruby Linear Algebra Library
33

44
A Fortran-based linear algebra package.
5-
----
5+
66
=== Features
77

88
Major features:
@@ -25,7 +25,6 @@ Minor features:
2525
* Determinant
2626
* 2-norm, 1-norm, infinity-norm, Frobenius norm
2727

28-
----
2928
=== Getting Started
3029

3130
Everything you need to know is in:
@@ -34,7 +33,6 @@ Everything you need to know is in:
3433

3534
and this README.
3635

37-
----
3836
=== Tutorial
3937

4038
$ irb
@@ -389,12 +387,9 @@ And now the fun stuff <tt> =)</tt>
389387
-0.000000 0.000000 1.000000 0.000000
390388
-0.000000 -0.000000 0.000000 1.000000
391389

392-
----
393-
394390
See the Linalg::DMatrix documentation for more info. The various
395391
tests in test/ are also instructive.
396392

397-
----
398393
=== Notes
399394

400395
I have intentionally left out the methods +column_size+ and +row_size+
@@ -412,7 +407,6 @@ If you have used +narray+, note that +linalg+ uses the mathematical
412407
definition of <em>rank</em>, which is equal to the number of columns
413408
only in the case of a nonsingular square matrix.
414409

415-
----
416410
=== ToDo
417411

418412
There are actually four internal matrix types: +SMatrix+, +DMatrix+,
@@ -428,7 +422,6 @@ implement.
428422
The other issue is that refactoring will make the +rdoc+ output less
429423
desirable, scattering methods away from their classes.
430424

431-
----
432425
=== Background
433426

434427
It started when I needed eigenvectors of a general matrix. I grabbed
@@ -463,15 +456,13 @@ library. But for now, +linalg+ exists because the LAPACK routines
463456
were "right there" in front of me, I needed them, and it was easy to
464457
call them.
465458

466-
----
467459
=== Details
468460

469461
Author:: James M. Lawrence <[email protected]>
470462
Requires:: Ruby 1.8.1 or later
471463
License:: Copyright (c) 2004-2008 James M. Lawrence.
472464
Released under the MIT license.
473465

474-
----
475466
=== License
476467

477468
Copyright (c) 2004-2008 James M. Lawrence

Diff for: install.rb

+2-1
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,12 @@ def doc
9595
} + [
9696
'ext/linalg/dmatrix.c',
9797
'lib/linalg/dmatrix/alias.rb',
98+
'INSTALL',
9899
'README',
99100
]
100101

101102
FileUtils.rm_rf "doc"
102-
RDoc::RDoc.new.document(rdoc_files)
103+
RDoc::RDoc.new.document(rdoc_files + ["--main", "README"])
103104
end
104105

105106
def distclean(rmdoc = true)

Diff for: lib/lapack.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
# structure for interacting with the +Lapack+ module. All +Lapack+
7272
# requires is that the appropriate to_FORTRANTYPE_ptr be implemented
7373
# on each parameter passed. From this perspective it is questionable
74-
# whether +Lapack+ should even be bundled the +linalg+ package.
74+
# whether +Lapack+ should even be bundled with the +linalg+ package.
7575
#
7676
# +DMatrix+, for example, is just a class which implements
7777
# the <tt>to_doublereal_ptr</tt> method, and the entirety of its

0 commit comments

Comments
 (0)