image thumbnail

Anymatrix

version 1.0 (1.05 MB) by Mantas Mikaitis
A MATLAB matrix collection with an interface to organize matrices

11 Downloads

Updated 11 Oct 2021

From GitHub

View license on GitHub

anymatrix - An extensible MATLAB matrix collection

About

Anymatrix is a MATLAB toolbox that provides an extensible collection of matrices, organized in groups, with the ability to search the collection by matrix properties.

Currently, the built-in collection contains matrices organized into 7 groups:

  • contest - the CONTEST test matrix toolbox of random matrices from networks.
  • core - miscellaneous matrices.
  • gallery - matrices from the MATLAB gallery.
  • hadamard - a large collection of Hadamard matrices.
  • matlab - other MATLAB matrices (not in gallery).
  • nessie - matrices from real-life networks.
  • regtools - matrices from regularization problems.

What's New

The following matrices have been added since v1.0.

  • core/collatz
  • core/hess_sublu
  • core/milnes
  • core/pick
  • Hadamard matrix of Edelman and Friedman: anymatrix('hadamard/hadamard',16,9)

Quick start

Installation

Clone the repository and add the root directory anymatrix/ to the MATLAB search path.

Inspect and generate a matrix

List the groups in the collection.

G = anymatrix('groups')

Show matrices in the core group.

M = anymatrix('groups', 'core')

Show help of a beta matrix in the core group.

anymatrix('help', 'core/beta')

Show properties appended to the beta matrix.

P = anymatrix('properties', 'core/beta')

Generate the 10-by-10 beta matrix.

[A, R] = anymatrix('core/beta', 10)

Search for matrices

Start by listing all the supported properties by the anymatrix.

P = anymatrix('properties')

Search for matrices that do not have a property 'symmetric'.

M = anymatrix('properties', 'not symmetric')

Look for matrices that are tridiagonal and not positive, or tridiagonal and symmetric.

M = anymatrix('properties', 'tridiagonal and (symmetric or not positive)')

Look for matrices that mention ' zero ' in their help comments.

M = anymatrix('lookfor', ' zero ')

Short forms

For invocations that use only character vectors or strings, the MATLAB command form of invocation (as opposed to the functional form) can be used:

anymatrix help core/beta

Commands can be abbreviated to the first one or two letters that uniquely specify them:

anymatrix p core/beta

Full list of accepted commands

List all the available commands and shorthand aliases of commands.

anymatrix('help')

Remote groups

The following groups are available for downloading into Anymatrix.

Examples

The examples/ directory contains codes that illustrate how to run tests over subsets of the matrices in Anymatrix.

Requirements

MATLAB 2020b or newer is required.

References

Nicholas J. Higham and Mantas Mikaitis. Anymatrix: An Extendable MATLAB Matrix Collection, Users' Guide. MIMS EPrint 2021.15, Manchester Institute for Mathematical Sciences, The University of Manchester, UK. Oct. 2021.

Nicholas J. Higham and Mantas Mikaitis. Anymatrix: An Extendable MATLAB Matrix Collection. Numer. Algorithms, 2021.

Licence

The code is distributed under the terms of the BSD 2-Clause License; see license.txt.

Cite As

Bib citations: https://github.com/mmikaitis/anymatrix/blob/master/citation.bib

MATLAB Release Compatibility
Created with R2021b
Compatible with R2020b and later releases
Platform Compatibility
Windows macOS Linux
Tags Add Tags

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

contest

contest/private

core

core/private

gallery

gallery/private

hadamard

hadamard/private

matlab

matlab/private

nessie

nessie/private

regtools

regtools/private

testing

testing/private

To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.