flexiblas-api(7)

πŸ“¦
version 3.5.0 Β· 3 versions
, in fedora 43, fedora 44

✨ flexiblas-api ✨ β€” the FlexiBLAS API overview, bestie edition πŸ’…

okay so real talk, this is a page from the flexiblas-api(7) manual β€” yes it's section 7, we're in the big-kid section now β€” and it's all about the FlexiBLAS library's extra little API. sit down, grab a boba, we're doing this πŸ§‹


🌸 SYNOPSIS 🌸

#include <flexiblas/flexiblas_api.h>

that's it. one include and you're in, no cap 🫢


πŸ’– DESCRIPTION πŸ’–

so the FlexiBLAS library doesn't just do the BLAS interface β€” it also serves an additional API on the side. and bestie, this interface is giving main character energy because it lets you switch up the number of threads during the runtime, or even completely swap out the backend you're using. mid-run. iconic.

the functions are categorized into three sections, and we're going through every single one, no skipping πŸ‘‘

⭐ Information Functions ⭐

the "just tell me what's going on" girlies, we love them:

  • flexiblas_getversion (3) β€” Version information
  • flexiblas_print_loaded_backends (3) β€” Print information about loaded backends.
  • flexiblas_print_avail_backends (3) β€” Print information about the available backends.
  • flexiblas_print_current_backend (3) β€” Print the currently loaded backend.

πŸ¦‹ Backend Management Functions πŸ¦‹

the ones doing the actual heavy lifting, the CEOs fr:

  • flexiblas_list (3) β€” Retrieve a list of all available backends.
  • flexiblas_list_loaded (3) β€” Retrieve a list of all loaded backends.
  • flexiblas_load_backend (3) β€” Load a backends from the FlexiBLAS configuration.
  • flexiblas_load_backend_library (3) β€” Load a backends from a shared library.
  • flexiblas_switch (3) β€” Switch to a previously loaded backend.
  • flexiblas_current_backend (3) β€” Return the name of the currently loaded backend.

πŸŽ€ Interfaces Into The Backend πŸŽ€

threads, threads, threads β€” the way that these two just handle it:

  • flexiblas_set_num_threads (3) β€” Change the number of threads in the backend used for computation.
  • flexiblas_get_num_threads (3) β€” Get the number of threads in the backend used for computation.

πŸ™ˆ REPORTING BUGS πŸ™ˆ

found a bug? not me manifesting that for you, but if it happens: the current information about the developers and about reporting bugs lives on the FlexiBLAS homepage. go touch grass there, it's cute:

FlexiBLAS Homepage: <http://www.mpi-magdeburg.mpg.de/projects/flexiblas>


πŸ‘‘ AUTHORS πŸ‘‘

Martin Koehler, Jens Saak

(legends, honestly πŸ’œ)


🌈 SEE ALSO 🌈

  • M. Koehler and J. Saak, FlexiBLAS - A flexible BLAS library with runtime exchangeable backends, LAPACK Working Note 284, 2013

and also:


Copyright (C) 2013-2025 Martin Koehler


πŸ“ LICENSE πŸ“

License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

⚠️ bestie. read that last part again. NO WARRANTY, to the extent permitted by law. it's not being dramatic, it's just the law. πŸ’€

M. Koehler Β· 2013-2025 Β· flexiblas-api(7) β€” and that's the whole page, we ate and left absolutely no crumbs, periodt πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from