Module: NMatrix::IO::HarwellBoeing

Defined in:
lib/nmatrix/io/harwell_boeing.rb

Defined Under Namespace

Classes: Reader

Class Method Summary collapse

Class Method Details

.load(file_path, opts = {}) ⇒ Object

Loads the contents of a valid Harwell Boeing format file and returns an NMatrix object with the values of the file and optionally only the header info.

Supports only assembled, non-symmetric, real matrices. File name must have matrix type as extension.

Example - test_file.rua

Arguments

  • file_path - Path of the Harwell Boeing file to load.

  • opts - Options for specifying whether you want

    the values and  header or only the header.
    

Options

  • :header - If specified as true, will return only the header of

    the HB file.Will return the NMatrix object and
    header as an array if left blank.
    

Usage

mat, head = NMatrix::IO::HarwellBoeing.load("test_file.rua")

head = NMatrix::IO::HarwellBoeing.load("test_file.rua", {header: true})

Alternate Usage

You can specify the file using NMatrix::IO::Reader.new(“path/to/file”) and then call header or values on the resulting object.


70
71
72
73
74
75
76
# File 'lib/nmatrix/io/harwell_boeing.rb', line 70

def load file_path, opts={}
  hb_obj = NMatrix::IO::HarwellBoeing::Reader.new(file_path)

  return hb_obj.header if opts[:header]

  [hb_obj.values, hb_obj.header]
end