mincirc.m

Go to the documentation of this file.

%>  \brief
%>  Return the integers ``ncol`` and ``nrow`` such that their sum
%>  (half the circumference of the resulting rectangle) is minimum while
%>  their product is larger than or equal the input integer-valued ``area``.
%>
%>  \details
%>  This function is particularly useful for computing
%>  the number of axes columns and rows in a single figure
%>  that yield the most square-like rectangle.
%>
%>  \note
%>  The function name stands for *minimum circumference*.<br>
%>
%>  \param[in]  area    :   The input scalar MATLAB whole number
%>                          representing the number of axes (subplots)
%>                          to arrange in a single figure.<br>
%>
%>  \return
%>  ``nrow``            :   The output scalar MATLAB whole-number
%>                          representing the number of rows of the rectangle.<br>
%>                          <br>
%>  ``ncol``            :   The output scalar MATLAB whole-number
%>                          representing the number of columns of the rectangle.
%>
%>  \interface{mincirc}
%>  \code{.m}
%>
%>      [nrow, ncol] = pm.math.mincirc(area);
%>
%>  \endcode
%>
%>  \example{mincirc}
%>  \include{lineno} example/math/mincirc/main.m
%>  \output{mincirc}
%>  \include{lineno} example/math/mincirc/main.out.m
%>
%>  \final{mincirc}
%>
%>  \author
%>  \JoshuaOsborne, May 21 2024, 9:43 PM, University of Texas at Arlington<br>
%>  \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
%>  \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin<br>
function [nrow, ncol] = mincirc(area)
    ncol = 1 : ceil(sqrt(area));
    nrow = ceil(area ./ ncol);
    [~, minloc] = min(nrow + ncol);
    nrow = nrow(minloc);
    ncol = ncol(minloc);
end