Why are so many of the interesting functions in the private directories?

In the FieldTrip code, we make a distinction between functions that the end-user should call, and helper functions that are called by other functions. Most functions that the end-user calls are prefixed with ft_xxx and are present in the main directory. The functions that the end-user should not call are mainly in the private directory. The reason for the private directory is that we can maintain backward compatibility for the main functions, but not for all functions. We want to be able to make changes in these helper functions (i.e. the private fnuctions) without worrying about whether any of the end-users is affected by the change.

The main functions have a stable user-interface (this also applies for example to the functions in the fileio and other modules), the private helper functions don't have a stable interface. We want people to use fieldtrip as a stable package, without having to worry that the update from one version to the next version breaks their own analysis scripts. If people start the private helper functions (which is not trivial due to the way that Matlab hides the private functions), they are themselves responsible for their scripts breaking due to changes in these helper functions.

faq/why_are_so_many_of_the_interesting_functions_in_the_private_directories.txt · Last modified: 2011/09/07 12:40 by lilla

You are here: startfaqwhy_are_so_many_of_the_interesting_functions_in_the_private_directories
CC Attribution-Share Alike 3.0 Unported
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0
This DokuWiki features an Anymorphic Webdesign theme, customised by Eelke Spaak and Stephen Whitmarsh.
Mobile Analytics Website Security Test