Home > Articles > Programming > C/C++

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

Returning a Class Object

There was a small controversy in the late 1980s with regard to the perceived inability of the C++ language to return a class object efficiently. Although it is more efficient to return a class object by reference or pointer rather than by value, the language does not provide any direct support for that. For example, there is no simple alternative to returning the local Matrix object by value:

Matrix operator+( const Matrix& m1, const Matrix& m2 )
{
        Matrix result;
        // do the arithmetic ...
        return result;
}

Although this revised implementation improves the operator's performance:

// more efficient, but results in a dangling reference 
Matrix& operator+( const Matrix& m1, const Matrix& m2 )
{
        Matrix result;
        // do the addition ...
        return result;
}

It also results in a dangling reference because the local object is destructed prior to the return of the function.

We can solve the problem of the dangling reference by allocating the object on the heap, such as the following:

// No way to guarantee the memory is not lost
Matrix& operator+( const Matrix& m1, const Matrix& m2 )
{
        Matrix *result = new Matrix;
        // do the addition ...
        return *result;
}

This is likely to result in memory leakage, however.

In practice, the problem is not quite as severe as it seems. The class object is not passed back by value. Rather, it is internally passed back through an additional reference parameter the compiler adds to the function. For example, the Matrix addition operator is generally transformed as follows:

// Psuedo C++ Code: 
// general internal transformation of function
//     returning a class object by value

void operator+( Matrix &_retvalue,
        const Matrix &m1, const Matrix &m2)
{
    Matrix sum; 

    // invoke default constructor
    sum.Matrix::Matrix();

    // do the math

    // copy construct local sum object into _retvalue
    retvalue.Matrix::Matrix( sum );
}

The objection to this solution was based on the unnecessary invocation of the class copy constructor to initialize the additional parameter with a copy of the local class object. It would be more efficient, it was argued, if the function replaced all uses of the local class object with the parameter. The computations are applied directly to the parameter, eliminating the need both for the local class object and the copy constructor invocation. Here is the addition operator under this more aggressive transformation:

// Psuedo C++ Code: 
// A more aggressive internal transformation
void operator+( Matrix &_retvalue,
        const Matrix &m1, const Matrix &m2)
{
  // replace local object with object to be returned
  // construct and do the math directly with that object

    // invoke default constructor
	_retvalue.Matrix::Matrix();

	// do the math

	// copy constructor no longer required
}

How much of a difference can that additional transformation make? I did a test a few years back, using the UNIX timex command to measure the performance with and without the application of the additional transformations:

Not Applied               : 1:48.52  
Applied              :  46.73		  

One proposed solution was a language extension, in which the class object to hold the return value was named following the parameter list of the function:

Matrix operator+( const Matrix& m1, const Matrix& m2 )
name result   // proposed language extension
{
        // no longer write: Matrix result;
        //...
        // no longer write: return result;
}

The language extension never became part of the language, but the optimization itself has become nearly universal. It is called the name return value optimization. It is applied implicitly by a compiler when the same named object is returned from all the exit points of a function.

Because it is an optimization rather than explicitly defined within the language, however, a compiler is not required to apply it. (At the time of this writing, I am aware of only two compilers that do not provide the named return value optimization: the GNU compiler gcc and Visual C++.)

To test whether your compiler applies it, run the following simple program:

class foobar {
public:
  foobar() { cout << "foobar::foobar()\n"; }
  ~foobar() { cout << "foobar::~foobar()\n"; }

  foobar( const foobar &rhs )
     { cout << "foobar::foobar( const foobar & )\n"; }

  foobar& operator=( const foobar &rhs )
     { cout << "foobar::operator=( const foobar & )\n"; }

  void ival( int nval ) { _ival = nval; }
private:
  int _ival;
};

foobar f( int val ) {
  foobar local;
  local.ival( val );
  return local;
}

int main(){
  foobar ml = f( 1024 );
  return 0;
}

If the compiler does not apply the optimization, there are two constructor calls (the construction of the local object and the copy construction of the return object) and two destructor calls as follows (this is generated by the GNU C++ compiler, gcc, running under Linux):

{stan@andromeda} : gcc nrv.cc -lstdc++ && a.out
foobar::foobar()
foobar::foobar( const foobar & )
foobar::~foobar()
foobar::~foobar()

By removing the local named object and computing the results directly within the named object, the copy constructor call and one of the destructor calls are eliminated. For example, here is the output of the same program with the optimization applied (this is generated by the KAI C++ compiler running under Linux):

{stan@andromeda} : KCC nrv.cc && a.out
foobar::foobar()
foobar::~foobar()

So, what if your compiler does not apply the name return value optimization? An alternative programming idiom is to provide a "computational constructor" that does the work previously done in the actual function, and to return that within the function. Here's a simple example using our foobar class:

class foobar {
public:
  // simple example of computational constructor ...
    foobar( int val ) : _ival( val )
     { cout << "foobar::foobar( " << val << " )\n"; }
  // ... 
};

/* previous version using local object and 'computation'
foobar f( int val ) {
  foobar local;
  local.ival( val );
  return local;
}
*/

// revised version invoking the 'computational' constructor
foobar f( int val ) { return foobar( 1024 ); }

In effect, we've hand-optimized the function: the local object is removed, and the computation is applied directly to the constructed object. The compiler completes the optimization by applying the constructor to the class reference parameter introduced to hold the result:

// C++ Pseudo Code:
// internal transformation of our hand-optimized function
void f( foobar & _result, int val ) 
{ _result.foobar::foobar( 1024 ); }

When compiled and executed, our revised program mimics the result of having the name return value optimization applied:

foobar::foobar( 1024 )
foobar::~foobar()
  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020