Skip to the content.

Dispstr - janklab.mlxshake.internal.logger.internal

janklab.mlxshake.internal.logger.internal.Dispstr

Helptext

All the dispstr implementation code, wrapped up in a class

We make it a class so that all the definitions can live in a single file, which makes it easy (well, maybe not easy, just not a huge pain in the ass) to transform the code to relocate its package, which will hopefully allow us to generate “compatters” for internal use by other libraries that don’t want to take a dependency on dispstr.

Class Contents

Methods

Method Description
sprintfv  
size2str  
prettyprintTabular_generic  
prettyprintTabular  
prettyprintStruct  
prettyprintCell  
prettyprintMatrix  
prettyprintArray  
num2cellstr  
mycombvec  
isErrorIdentifier  
dispc  
dispStruct  
dispCell  
display  
disp  
convertArgsForPrintf  
Dispstr Constructor.

Methods

sprintfv

Attributes: Static

Signature:

out = Dispstr.sprintfv(format, varargin)

Helptext:

SPRINTFV “Vectorized” sprintf

out = sprintfv(format, varargin)

SPRINTFV is an array-oriented form of sprintf that applies a format to array inputs and produces a cellstr.

This is not a high-performance method. It’s a convenience wrapper around a loop around sprintf().

Returns cellstr.

size2str

Attributes: Static

Signature:

out = Dispstr.size2str(sz)

Helptext:

SIZE2STR Format an array size for display

out = size2str(sz)

Sz is an array of dimension sizes, in the format returned by SIZE.

Examples:

size2str(magic(3))

prettyprintTabular_generic

Attributes: Static

Signature:

out = Dispstr.prettyprintTabular_generic(varargin)

Helptext:

A generic tabular pretty-print that can be used for tabulars or relations

prettyprintTabular

Attributes: Static

Signature:

out = Dispstr.prettyprintTabular(t)

Helptext:

PRETTYPRINT_TABULAR Tabular implementation of prettyprint

prettyprintStruct

Attributes: Static

Signature:

out = Dispstr.prettyprintStruct(s)

Helptext:

PRETTYPRINT_STRUCT struct implementation of prettyprint

prettyprintCell

Attributes: Static

Signature:

out = Dispstr.prettyprintCell(c)

Helptext:

PRETTYPRINT_CELL Cell implementation of prettyprint

prettyprintMatrix

Attributes: Static

Signature:

out = Dispstr.prettyprintMatrix(strs)

Helptext:

Pretty-print a matrix of arbitrary display strings

out = prettyprintMatrix(strs)

strs is a matrix of strings which are already converted to their display form.

prettyprintArray

Attributes: Static

Signature:

out = Dispstr.prettyprintArray(strs)

Helptext:

PRETTYPRINT_ARRAY Pretty-print an array from dispstrs

out = prettyprintArray(strs)

strs (string) is an array of display strings of any size.

num2cellstr

Attributes: Static

Signature:

out = Dispstr.num2cellstr(x)

Helptext:

NUM2CELLSTR Like num2str, but return cellstr of individual number strings

mycombvec

Attributes: Static

Signature:

out = Dispstr.mycombvec(vecs)

Helptext:

MYCOMBVEC All combinations of values from vectors

This is similar to Matlab’s combvec, but has a different signature.

isErrorIdentifier

Attributes: Static

Signature:

out = Dispstr.isErrorIdentifier(str)

Helptext:

janklab.mlxshake.internal.logger.internal.Dispstr.isErrorIdentifier is a function. out = isErrorIdentifier(str)

dispc

Attributes: Static

Signature:

out = Dispstr.dispc(x)

Helptext:

DISPC Display, with capture

dispStruct

Attributes: Static

Signature:

Dispstr.dispStruct(x)

Helptext:

janklab.mlxshake.internal.logger.internal.Dispstr.dispStruct is a function. dispStruct(x)

dispCell

Attributes: Static

Signature:

Dispstr.dispCell(c)

Helptext:

janklab.mlxshake.internal.logger.internal.Dispstr.dispCell is a function. dispCell(c)

display

Attributes: Static

Signature:

Dispstr.display(x)

Helptext:

DISPLAY Display array. DISPLAY(X) is called for the object X when the semicolon is not used to terminate a statement.

For example, X = datetime(2014,1:5,1) calls DISPLAY(X) while X = datetime(2014,1:5,1); does not.

A typical implementation of DISPLAY calls DISP to do most of the work. To customize the display of objects, overload the DISP function. Note that DISP does not display empty arrays.

See also DISP, matlab.mixin.CustomDisplay, EVALC,

disp

Attributes: Static

Signature:

Dispstr.disp(x)

Helptext:

DISP Display array. DISP(X) displays array X without printing the array name or additional description information such as the size and class name. In all other ways it’s the same as leaving the semicolon off an expression except that nothing is shown for empty arrays.

If X is a string or character array, the text is displayed.

See also FPRINTF, SPRINTF, INT2STR, NUM2STR, RATS, FORMAT, DETAILS.

convertArgsForPrintf

Attributes: Static

Signature:

out = Dispstr.convertArgsForPrintf(args)

Helptext:

janklab.mlxshake.internal.logger.internal.Dispstr.convertArgsForPrintf is a function. out = convertArgsForPrintf(args)

Dispstr

Signature:

obj = Dispstr()

Helptext:

All the dispstr implementation code, wrapped up in a class

We make it a class so that all the definitions can live in a single file, which makes it easy (well, maybe not easy, just not a huge pain in the ass) to transform the code to relocate its package, which will hopefully allow us to generate “compatters” for internal use by other libraries that don’t want to take a dependency on dispstr.