Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical

Re: How to document complex data structures?

by tilly (Archbishop)
on Oct 21, 2007 at 21:35 UTC ( #646320=note: print w/replies, xml ) Need Help??

in reply to How to document complex data structures?

It depends on the situation.

First of all, if I have a regular structure, I can document it with long descriptive variable names. For instance $orders_by_user_by_month is going to be a hash of hashes of arrays. And the keys to use to access it are documented in the name.

Secondly if a structure gets too complex, don't be afraid to hide details behind objects. For instance in the previous example, an order might well be an object with lots of data about the order. So I really had a hash of hashes of arrays of hashes.

Thirdly unless I really need it, I get very scared of positional data. Because it is easy to mix it up. Which means that I either don't use it, or I try to limit the use of it to a small portion of code. For instance in your data structure I dislike the positional information in means and variances.

So in your case I'd suggest something like this:

[ { original => { mean => $original_mean, variance => $original_variance, values => { $id => $value, ... }, }, changed => { mean => $changed_mean, variance => $changed_variance, values => { $id => $value, ... }, }, ... ]
and then (depending on how it is used) I'd hide the details of the original and changed data structures behind an object. After which you could choose to have it calculate the mean and variance on the fly. Also you'd probably come up with some opportunities to clean up the code which produces it.

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://646320]
and not a whimper to be heard...

How do I use this? | Other CB clients
Other Users?
Others drinking their drinks and smoking their pipes about the Monastery: (4)
As of 2018-05-27 12:50 GMT
Find Nodes?
    Voting Booth?