Update QTestLib documentation with chart use case.

1 files changed, 269 insertions, 0 deletions

diff --git a/examples/qtestlib/tutorial5/containers.cpp b/examples/qtestlib/tutorial5/containers.cpp
new file mode 100644
index 0000000..fe68c85
--- /dev/null
+++ b/examples/qtestlib/tutorial5/containers.cpp
@@ -0,0 +1,269 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+// This file contains benchmarks for comparing QVector against std::vector
+
+#include <QtCore>
+#include <QVector>
+#include <vector>
+
+#include <qtest.h>
+
+template <typename T> // T is the item type
+class UseCases {
+public:
+    virtual ~UseCases() {}
+
+    // Use case: Insert \a size items into the vector.
+    virtual void insert(int size) = 0;
+
+    // Use case: Lookup \a size items from the vector.
+    virtual void lookup(int size) = 0;
+};
+
+template <typename T>
+T * f(T *ts) // dummy function to prevent code from being optimized away by the compiler
+{
+    return ts;
+}
+
+// This subclass implements the use cases using QVector as efficiently as possible.
+template <typename T>
+class UseCases_QVector : public UseCases<T>
+{
+    void insert(int size)
+    {
+        QVector<T> v;
+        T t;
+        QBENCHMARK {
+            for (int i = 0; i < size; ++i)
+                v.append(t);
+        }
+    }
+
+    void lookup(int size)
+    {
+        QVector<T> v;
+
+        T t;
+        for (int i = 0; i < size; ++i)
+            v.append(t);
+
+        T *ts = new T[size];
+        QBENCHMARK {
+            for (int i = 0; i < size; ++i)
+                ts[i] = v.value(i);
+        }
+        f<T>(ts);
+        delete[] ts;
+    }
+};
+
+// This subclass implements the use cases using std::vector as efficiently as possible.
+template <typename T>
+class UseCases_stdvector : public UseCases<T>
+{
+    void insert(int size)
+    {
+        std::vector<T> v;
+        T t;
+        QBENCHMARK {
+            for (int i = 0; i < size; ++i)
+                v.push_back(t);
+        }
+    }
+
+    void lookup(int size)
+    {
+        std::vector<T> v;
+
+        T t;
+        for (int i = 0; i < size; ++i)
+            v.push_back(t);
+
+        T *ts = new T[size];
+        QBENCHMARK {
+            for (int i = 0; i < size; ++i)
+                ts[i] = v[i];
+        }
+        f<T>(ts);
+        delete[] ts;
+    }
+};
+
+struct Large { // A "large" item type
+    int x[1000];
+};
+
+// Symbian devices typically have limited memory
+#ifdef Q_OS_SYMBIAN
+#  define LARGE_MAX_SIZE 2000
+#else
+#  define LARGE_MAX_SIZE 20000
+#endif
+
+class tst_vector_vs_std : public QObject
+{
+    Q_OBJECT
+public:
+    tst_vector_vs_std()
+    {
+        useCases_QVector_int = new UseCases_QVector<int>;
+        useCases_stdvector_int = new UseCases_stdvector<int>;
+
+        useCases_QVector_Large = new UseCases_QVector<Large>;
+        useCases_stdvector_Large = new UseCases_stdvector<Large>;
+    }
+
+private:
+    UseCases<int> *useCases_QVector_int;
+    UseCases<int> *useCases_stdvector_int;
+    UseCases<Large> *useCases_QVector_Large;
+    UseCases<Large> *useCases_stdvector_Large;
+
+private slots:
+    void insert_int_data();
+    void insert_int();
+    void insert_Large_data();
+    void insert_Large();
+    void lookup_int_data();
+    void lookup_int();
+    void lookup_Large_data();
+    void lookup_Large();
+};
+
+void tst_vector_vs_std::insert_int_data()
+{
+    QTest::addColumn<bool>("useStd");
+    QTest::addColumn<int>("size");
+
+    for (int size = 10; size < 20000; size += 100) {
+        const QByteArray sizeString = QByteArray::number(size);
+        QTest::newRow(("std::vector-int--" + sizeString).constData()) << true << size;
+        QTest::newRow(("QVector-int--" + sizeString).constData()) << false << size;
+    }
+}
+
+void tst_vector_vs_std::insert_int()
+{
+    QFETCH(bool, useStd);
+    QFETCH(int, size);
+
+    if (useStd)
+        useCases_stdvector_int->insert(size);
+    else
+        useCases_QVector_int->insert(size);
+}
+
+void tst_vector_vs_std::insert_Large_data()
+{
+    QTest::addColumn<bool>("useStd");
+    QTest::addColumn<int>("size");
+
+    for (int size = 10; size < LARGE_MAX_SIZE; size += 100) {
+        const QByteArray sizeString = QByteArray::number(size);
+        QTest::newRow(("std::vector-Large--" + sizeString).constData()) << true << size;
+        QTest::newRow(("QVector-Large--" + sizeString).constData()) << false << size;
+    }
+}
+
+void tst_vector_vs_std::insert_Large()
+{
+    QFETCH(bool, useStd);
+    QFETCH(int, size);
+
+    if (useStd)
+        useCases_stdvector_Large->insert(size);
+    else
+        useCases_QVector_Large->insert(size);
+}
+
+//! [1]
+void tst_vector_vs_std::lookup_int_data()
+{
+    QTest::addColumn<bool>("useStd");
+    QTest::addColumn<int>("size");
+
+    for (int size = 10; size < 20000; size += 100) {
+        const QByteArray sizeString = QByteArray::number(size);
+        QTest::newRow(("std::vector-int--" + sizeString).constData()) << true << size;
+        QTest::newRow(("QVector-int--" + sizeString).constData()) << false << size;
+    }
+}
+//! [1]
+
+//! [2]
+void tst_vector_vs_std::lookup_int()
+{
+    QFETCH(bool, useStd);
+    QFETCH(int, size);
+
+    if (useStd)
+        useCases_stdvector_int->lookup(size); // Create a std::vector and run the benchmark.
+    else
+        useCases_QVector_int->lookup(size); // Create a QVector and run the benchmark.
+}
+//! [2]
+
+void tst_vector_vs_std::lookup_Large_data()
+{
+    QTest::addColumn<bool>("useStd");
+    QTest::addColumn<int>("size");
+
+    for (int size = 10; size < LARGE_MAX_SIZE; size += 100) {
+        const QByteArray sizeString = QByteArray::number(size);
+        QTest::newRow(("std::vector-Large--" + sizeString).constData()) << true << size;
+        QTest::newRow(("QVector-Large--" + sizeString).constData()) << false << size;
+    }
+}
+
+void tst_vector_vs_std::lookup_Large()
+{
+    QFETCH(bool, useStd);
+    QFETCH(int, size);
+
+    if (useStd)
+        useCases_stdvector_Large->lookup(size);
+    else
+        useCases_QVector_Large->lookup(size);
+}
+
+QTEST_MAIN(tst_vector_vs_std)
+#include "main.moc"