ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
Functions
getFileName.m File Reference

Go to the source code of this file.

Functions

function getFileName (in prefix)
 Return a scalar MATLAB string containing a file name based on the current date and time. More...
 

Function Documentation

◆ getFileName()

function getFileName ( in  prefix)

Return a scalar MATLAB string containing a file name based on the current date and time.

This functionality is primarily used by the ParaMonte samplers to generate random output file base name for situations where the user does not specify a name.

Parameters
[in]prefix: The input scalar MATLAB string, containing the desired prefix, e.g., ParaDRAM, ParaDISE, ParaNest, ...
(optional, default = "")
Returns
str : The output scalar MATLAB string containing an output file name based on the current date and time.
The following represents the template used across all programming language environments:
YYYYMMDD_HHMMSS_MMM
or
prefix_YYYYMMDD_HHMMSS_MMM
where,
  1. prefix is replaced with the input prefix name.
  2. YYYY is replaced with the current Gregorian year.
  3. MM is replaced with the current month of year.
  4. DD is replaced with the current day of month.
  5. HH is replaced with the current hour of day.
  6. MM is replaced with the current minute of hour.
  7. SS is replaced with the current second of minute.
  8. MMM is replaced with the current millisecond of second.


Possible calling interfaces ⛓

str = pm.io.getFileName()
str = pm.io.getFileName([])
str = pm.io.getFileName(prefix)


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
4disp('pm.io.getFileName()')
5disp( pm.io.getFileName() )
6
7disp('pm.io.getFileName([])')
8disp( pm.io.getFileName([]) )
9
10disp('pm.io.getFileName("now")')
11disp( pm.io.getFileName("now") )
getFileName
function getFileName(in prefix)
Return a scalar MATLAB string containing a file name based on the current date and time.
root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1pm.io.getFileName()
220240711_094851_539
3pm.io.getFileName([])
420240711_094851_558
5pm.io.getFileName("now")
6now_20240711_094851_559


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.

  1. 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.
  2. 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, 6:13 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