extra/math/blas/config/config-docs.factor

   1 USING: alien.fortran help.markup help.syntax math.blas.config ;
   2 IN: math.blas.config
   3
   4 ARTICLE: "math.blas.config" "Configuring the BLAS interface"
   5 "The " { $link "math.blas-summary" } " chooses the underlying BLAS interface to use based on the values of the following global variables:"
   6 { $subsections
   7     blas-library
   8     blas-fortran-abi
   9     deploy-blas?
  10 }
  11 "The interface attempts to set default values based on the ones encountered on the Factor project's build machines. If these settings don't work with your system's BLAS, or you wish to use a commercial BLAS, you may change the global values of those variables in your " { $link ".factor-rc" } ". For example, to use AMD's ACML library on Windows with " { $snippet "math.blas" } ", your " { $snippet ".factor-rc" } " would look like this:"
  12 { $code "
  13 USING: math.blas.config namespaces ;
  14 \"X:\\path\\to\\acml.dll\" blas-library set-global
  15 intel-windows-abi blas-fortran-abi set-global
  16 t deploy-blas? set-global
  17 " }
  18 "To take effect, the " { $snippet "blas-library" } " and " { $snippet "blas-fortran-abi" } " variables must be set before any other " { $snippet "math.blas" } " vocabularies are loaded."
  19 ;
  20
  21 HELP: blas-library
  22 { $var-description "The name of the shared library containing the BLAS interface to load. The value of this variable must be a valid shared library name that can be passed to " { $link add-fortran-library } ". To take effect, this variable must be set before any other " { $snippet "math.blas" } " vocabularies are loaded. See " { $link "math.blas.config" } " for details and examples." } ;
  23
  24 HELP: blas-fortran-abi
  25 { $var-description "The Fortran ABI used by the BLAS interface specified in the " { $link blas-library } " variable. The value of " { $snippet "blas-fortran-abi" } " must be one of the " { $link "alien.fortran-abis" } " that can be passed to " { $link add-fortran-library } ". To take effect, this variable must be set before any other " { $snippet "math.blas" } " vocabularies are loaded. See " { $link "math.blas.config" } " for details and examples." } ;
  26
  27 HELP: deploy-blas?
  28 { $var-description "If set to a true value, the BLAS library will be configured to deploy with applications that use it. To take effect, this variable must be set before any other " { $snippet "math.blas" } " vocabularies are loaded. See " { $link "math.blas.config" } " for details and examples." } ;
  29
  30 ABOUT: "math.blas.config"