{"id":3063,"date":"2018-07-14T00:14:45","date_gmt":"2018-07-13T22:14:45","guid":{"rendered":"https:\/\/mariusbancila.ro\/blog\/?p=3063"},"modified":"2018-07-14T00:14:45","modified_gmt":"2018-07-13T22:14:45","slug":"partial-function-applications","status":"publish","type":"post","link":"https:\/\/mariusbancila.ro\/blog\/2018\/07\/14\/partial-function-applications\/","title":{"rendered":"Partial function applications"},"content":{"rendered":"

Partial function application is the process of taking a function with a number of arguments, fixing (or binding) some of its arguments and producing a new function with a smaller number of arguments. In C++, this can be achieved with std::bind()<\/a> that generates a forwarding call wrapper for a callable object, and the placeholder objects from the std::placeholders<\/a> namespace that are used for binding arguments to the callable object.<\/p>\n

<\/p>\n

To see how this works, let’s start with the following function that is supposed to print a document to a specified printer with various settings. These include page orientation and size, number of copies, size of margins, resolution, and scale. Some of these have default values because in most cases you’d use the same values for these arguments.<\/p>\n

enum class page_size {Letter, A0, A1, A2, A3, A4, A5, A6};\r\nenum class page_layout {portrait, landscape};\r\nenum class page_margins {standard, minimum, maximum};\r\n\r\nvoid print(std::string_view destination,\r\n           page_layout const orientation,\r\n           page_size const size,\r\n           int const copies = 1,\r\n           page_margins const margins = page_margins::standard,\r\n           int const dpi = 300,\r\n           double const scale = 1.0)\r\n{\r\n  \/* print document *\/\r\n}<\/pre>\n
If you want to print to a printer called “Printer” one copy on an A4 page in portrait layout, with standard margins, 300 DPI and no scaling, then you make the following call, relying on the default values.<\/p>\n
print(\"Printer\", page_layout::portrait, page_size::A4);<\/pre>\n
Should you need two copies of the document, you need to explicitly provide that argument in the call.<\/p>\n
print(\"Printer\", page_layout::portrait, page_size::A4, 2);<\/pre>\n
What if you need to print with a different resolution, such as 600 DPI instead of 300? In C++, arguments are positional, they need to be supplied in the order defined by the function declaration. Other languages, such as C#, support named arguments so that you can provide arguments in any order given that you specify the name of the parameter. Because of this, however, when you need to specify other value than the default for the DPI, you also need to specify values for the number of copies and the margins. In other words, your call would look like this.<\/p>\n
print(\"Printer\", \r\n      page_layout::portrait, \r\n      page_size::A4, \r\n      1, \r\n      page_margins::standard, \r\n      600);<\/pre>\n
This is where std::bind()<\/tt> can step in. Default arguments for function parameters and binding are different things, but the effects are somehow similar. For instance, if all we need to change is the page size and margins, we can leverage a partial function application on the original function (that may also have default arguments) and create a callable forwarding wrapper with placeholders for the parameters we need to supply on every call and fix values for the others. Placeholders are objects in the std::placeholders<\/tt> namespace called _1<\/tt>, _2<\/tt>, …, _N<\/tt> (where N is implementation defined), whose type is also an implementation detail (although it must be default and copy-constructible). <\/p>\n
using namespace std::placeholders;\r\nauto fprint = std::bind(print, \"Printer\", page_layout::portrait, _1, 1, _2, 300, 1.0);\r\n\r\nfprint(page_size::Letter, page_margins::maximum);\r\nfprint(page_size::A3, page_margins::minimum);<\/pre>\n
In this example _1<\/tt> and _2<\/tt> are objects that are stored in the function object generatated by std::bind()<\/tt>. When the function object is invoked with arguments, each placeholder is replaced by the corresponding unbound argument (_1<\/tt> by the first argument, _2<\/tt> by the second, etc.). One thing to notice is that when creating a callable wrapper with std::bind()<\/tt> you must supply values even for the parameters with default arguments.<\/p>\n
Of course, you’re not going to create a binding for making one or two calls like that. But you may have situations when one function with multiple arguments could be called repeatedly within the same routine or algorithm with only some of them changed. In this case you can use std::bind()<\/tt>.<\/p>\n
It is also useful when you want to use a function with multiple arguments with a standard algorithm that expects fewer arguments than the function requires. In the following example, the print()<\/tt> function is used to print the same document to multiple printers. std::for_each<\/tt> is used for this purpose, although the only argument that is supplied to the function is the printer name. Therefore, a callable wrapper is created with std::bind()<\/tt>.<\/p>\n
std::vector<std::string> printers{ \"Printer\", \"Default printer\", \"PDF printer\" };\r\nstd::for_each(\r\n   std::begin(printers), std::end(printers),\r\n   std::bind(print, _1, \r\n                    page_layout::portrait,\r\n                    page_size::A4,\r\n                    1,\r\n                    page_margins::standard,\r\n                    600,\r\n                    1.0));<\/pre>\n
In the examples so far, the print()<\/tt> function was a free function, but the process works the same with member functions too. In the following example, print()<\/tt> is a member of the document<\/tt> class.<\/p>\n
struct document\r\n{\r\n   void print(std::string_view destination,\r\n      page_layout const orientation,\r\n      page_size const size,\r\n      int const copies = 1,\r\n      page_margins const margins = page_margins::standard,\r\n      int const dpi = 300,\r\n      double const scale = 1.0)\r\n   {\r\n      \/* print document *\/\r\n   }\r\n};<\/pre>\n
To invoke this member function on a particular instance of the class you must suply the object as an argument to std::bind()<\/tt>; the rest is the same.<\/p>\n
document doc;\r\nauto fprint = std::bind(&document::print, &doc, \"Printer\", page_layout::portrait, _1, 1, _2, 300, 1.0);\r\n\r\nfprint(page_size::Letter, page_margins::maximum);\r\nfprint(page_size::A3, page_margins::minimum);<\/pre>\n
std::for_each(\r\n   std::begin(printers), std::end(printers),\r\n   std::bind(&document::print, &doc, _1,\r\n                                     page_layout::portrait,\r\n                                     page_size::A4,\r\n                                     1,\r\n                                     page_margins::standard,\r\n                                     600,\r\n                                     1.0));<\/pre>\n","protected":false},"excerpt":{"rendered":"
Partial function application is the process of taking a function with a number of arguments, fixing (or binding) some of its arguments and producing a new function with a smaller number of arguments. In C++, this can be achieved with std::bind()<\/a> that generates a forwarding call wrapper for a callable object, and the placeholder objects from the std::placeholders<\/a> namespace that are used for binding arguments to the callable object.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","advgb_blocks_editor_width":"","advgb_blocks_columns_visual_guide":"","_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[7],"tags":[451,223,561],"class_list":["post-3063","post","type-post","status-publish","format-standard","hentry","category-c","tag-c","tag-functional","tag-placeholders"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t