source: nappy/trunk/listManipulator.py @ 343

"""
listManipulator.py
===================

A container module for RecursiveListManipulator classes that transform
arrays into multi-dimensional list objects. Wrapper functions are
provided to call these directly as functions.

"""

def recursiveListPopulator(inlist, array, dimlist):
    """
    Function wrapper around class method RecursiveListManipulator().populator().
    """
    return RecursiveListManipulator().populator(inlist, array, dimlist)

def recursiveListWriter(inlist, dimlist, floatFormat="%s"):
    """
    Function wrapper around class method RecursiveListManipulator().writeLines().
    """
    return RecursiveListManipulator().writeLines(inlist, dimlist, floatFormat)


class RecursiveListManipulator:

    """
    Methods to convert a 1-D array into a multi-dimensional list.
    """

    def populator(self, inlist, array, dimlist):    
        """
        Populates the list object 'inlist' (e.g. []) with sublists of
        dimensionality defined in the 'dimlist' list of dimensions (e.g [181, 360]).
        At the deepest level it then inserts values from the long list
        'array'.
        """

        if not hasattr(self, "_counter"):
            self._counter=0
        if len(dimlist[1:])>0:
            for i in range(dimlist[0]):
                inlist.append([])
                self.populator(inlist[i], array, dimlist[1:])
        else:
            count=self._counter
            self._counter=self._counter+dimlist[0]
            endcount=self._counter
            for i in range(count, endcount):
                inlist.append(array[i])
        return inlist

    def writeLines(self, inlist, dimlist, floatFormat="%s"):
        """
        Method to walk through all the levels of the multi-level list object
        'inlist' and writes out appropriate values to a list of lines called
        'self.rtlines'. 'dimlist' is a list of the dimensions within 'inlist'.
        """
        if not hasattr(self, "rtlines"):
            self.rtlines=[]
        if len(dimlist[1:])>0:
            for i in range(dimlist[0]):
                self.writeLines(inlist[i], dimlist[1:], floatFormat)
        else:
            var_string=""
            for i in range(dimlist[0]):
                var_string=var_string+((floatFormat+"    ") % inlist[i])
            self.rtlines.append("%s\n" % var_string.rstrip())
        return self.rtlines