Structure outline

Prints the hierarchy outline of a structure with optionally, field values.

Description

This function prints the hierarchical outline of a structure to the command window or a file. Optionally, field values can be printed as well.

type "help strucdisp" for more information about this function.

Acknowledgements

The author wishes to acknowledge the following in the creation of this submission:
Display_structure

• MATLAB release: MATLAB 7.5 (R2007b)

[John D'Errico]

I do like this utility, but there is a significant bug. The help states that all arguments but the first are optional. I tried passing in the third argument, but not the second, supplying an empty argument to the second as a placeholder. This should be acceptable. Its also the standard way that Matlab tools use to allow some arguments to be defaulted.

strucdisp(s,[])
??? Operands to the || and && operators must be convertible to logical scalar values.

Error in ==> strucdisp>get_fields at 151
            if (depth < 0) || (indent + 1 < depth)

Error in ==> strucdisp at 64
    liststr = get_fields(structure, 0, depth, flag_value, max_length);

Arguments that take on a default value should test for empty values provided using isempty, and if empty, then provide the default.

I'd have rated this a 5 otherwise, and I will happily raise my rating to that level if it is repaired.

[John D'Errico]

Problem resolved. My new rating is now the correct one.

This will be a useful utility for those of us who sometimes generate complicated structures.

[B. Roossien]

This function has been updated. Some bugs were fixed. Its performance is enhanced and new functionalities (printing small matrices and handling structure arrays) have been added.

[Holger Krause]

I'm using this function to print out nicely formatted log files containing parameters of various types. strucdisp is just the right tool for this job.

There are three smaller issues:

1. It would be nice, to handle logicals separately (output as text 'true' or 'false' at least for single values).

2. The line for numeric vectors is missing a space in front of the opening bracket.

3. In some cases empty fields get duplicated and occur one time as an empty string '' and a second time as an empty double array [ ].

[Rahul Y D]

thank you very much really helpful function

[B. Roossien]

I've fixed a number of bugs and added some improvements following feedback from Holger Krause and Juergen Kurzmann. The new file should be available in 2-3 days.

[Juergen Kurzmann]

This is a really helpful function for getting a concise overview of data structures (struct) as well as for their documentation!

[Mais]

very useful

[Benjamin]

 

[Joseph]

This is really great. Good job.

[Matt Brunner]

Awesome! Exactly what I was looking for. Thank you.

[Roger Parkyn]

Worked for me.