lms_control_type structure#

    struct lms_control_type{T}
      f_indexing::Bool
      error::Int32
      out::Int32
      print_level::Int32
      memory_length::Int32
      method::Int32
      any_method::Bool
      space_critical::Bool
      deallocate_error_fatal::Bool
      prefix::NTuple{31,Cchar}

detailed documentation#

control derived type as a Julia structure

components#

Bool f_indexing

use C or Fortran sparse matrix indexing

Int32 error

unit for error messages

Int32 out

unit for monitor output

Int32 print_level

controls level of diagnostic output

Int32 memory_length

limited memory length

Int32 method

limited-memory formula required (others may be added in due course):

  • 1 BFGS (default).

  • 2 Symmetric Rank-One (SR1).

  • 3 The inverse of the BFGS formula.

  • 4 The inverse of the shifted BFGS formula. This should be used instead of .method = 3 whenever a shift is planned.

Bool any_method

allow space to permit different methods if required (less efficient)

Bool space_critical

if space is critical, ensure allocated arrays are no bigger than needed

Bool deallocate_error_fatal

exit if any deallocation fails

NTuple{31,Cchar} prefix

all output lines will be prefixed by prefix(2:LEN(TRIM(.prefix))-1) where prefix contains the required string enclosed in quotes, e.g. “string” or ‘string’