Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.53 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.53 KB

haikunatormatlab

Generate memorable names for instances, files, experiments etc. in MATLAB. This is modeled after the python port haikunatorpy.

Installation

Simply add this repository to your MATLAB path using the IDE Home>Set Path. There is no need to include subfolders. Alternatively use the addpath function.

Currently the minimum version is set to 2017a to take advantage of tidy argument validation. It may work starting at 2016, but has not been tested so a warning will appear.

Usage

There is only one Class Haikunator with one method haikunate.

% Initalize and use current seed
h = Haikunator()

% Initalize with specified seed
h = Haikunator('seed',32)

% Standard useage
h.haikunate(); % = 'still-sun-8919'

% Use underscores as delimiter
h.haikunate('delimiter','_'); % = 'orange_morning_5786'

% Use hex token
h.haikunate('token_hex',true); % = 'lively-hill-6b04'

% Change token_chars
h.haikunate('token_chars','HAIKUNATOR'); % 'lucky-king-UHNU'

Other Languages

Haikunator is also available in other languages. Check them out: