Functions
function	mincirc (in area)
	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`. More...

Function Documentation

◆ mincirc()

function mincirc ( in area )

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.

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.

Parameters

[in] area : The input scalar MATLAB whole number representing the number of axes (subplots) to arrange in a single figure.

Returns: nrow : The output scalar MATLAB whole-number representing the number of rows of the rectangle.

ncol : The output scalar MATLAB whole-number representing the number of columns of the rectangle.

Possible calling interfaces ⛓

: [nrow, ncol] = pm.math.mincirc(area);

Example usage ⛓

: 1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.

2addpath('../../../'); % Add the ParaMonte library root directory to the search path.

3

4pm.matlab.show()

5pm.matlab.show("[nrow, ncol] = pm.math.mincirc(5)")

6 [nrow, ncol] = pm.math.mincirc(5);

7pm.matlab.show("[nrow, ncol]")

8pm.matlab.show( [nrow, ncol] )

9

10pm.matlab.show()

11pm.matlab.show("[nrow, ncol] = pm.math.mincirc(21)")

12 [nrow, ncol] = pm.math.mincirc(21);

13pm.matlab.show("[nrow, ncol]")

14pm.matlab.show( [nrow, ncol] )

15

16[nrow, ncol] = pm.math.mincirc(5);

17assert(all([nrow, ncol] == [3, 2]))

18

19[nrow, ncol] = pm.math.mincirc(21);

20assert(all([nrow, ncol] == [7, 3]))

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1

2[nrow, ncol] = pm.math.mincirc(5)

3[nrow, ncol]

4 3 2

5

6[nrow, ncol] = pm.math.mincirc(21)

7[nrow, ncol]

8 7 3

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Joshua Alexander Osborne, May 21 2024, 9:43 PM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Functions

Function Documentation

◆ mincirc()