Exporter.h

Go to the documentation of this file.

/* Copyright 2019 Kristofer Björnson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef COM_DAFER45_TBTK_EXPORTER
#define COM_DAFER45_TBTK_EXPORTER

#include "TBTK/AnnotatedArray.h"
#include "TBTK/MultiCounter.h"
#include "TBTK/Property/AbstractProperty.h"
#include "TBTK/PropertyConverter.h"
#include "TBTK/SpinMatrix.h"

#include <complex>
#include <fstream>
#include <string>
#include <vector>

namespace TBTK{

class Exporter{
public:
    enum class Format {RowMajor, ColumnMajor};

    Exporter();

    template<typename DataType>
    void save(
        const Property::AbstractProperty<DataType> &abstractProperty,
        const std::string &filename
    ) const;

    template<typename DataType>
    void save(
        const Property::AbstractProperty<DataType> &abstractProperty,
        const Index &pattern,
        const std::string &filename
    ) const;

    template<typename DataType>
    void save(
        const Array<DataType> &array,
        const std::string &filename
    ) const;

    void setFormat(Format format);
private:
    Format format;

    template<typename DataType>
    void write(std::ofstream &stream, const DataType &value) const;
};

inline Exporter::Exporter(){
    format = Format::RowMajor;
}

template<typename DataType>
void Exporter::save(
    const Property::AbstractProperty<DataType> &abstractProperty,
    const std::string &filename
) const{
    AnnotatedArray<DataType, Subindex> annotatedArray
        = PropertyConverter::convert(abstractProperty);

    save(annotatedArray, filename);
}

template<typename DataType>
void Exporter::save(
    const Property::AbstractProperty<DataType> &abstractProperty,
    const Index &pattern,
    const std::string &filename
) const{
    AnnotatedArray<DataType, Subindex> annotatedArray
        = PropertyConverter::convert(abstractProperty, pattern);

    save(annotatedArray, filename);
}

template<typename DataType>
void Exporter::save(
    const Array<DataType> &array,
    const std::string &filename
) const{
    Array<DataType> outputArray;
    switch(format){
    case Format::RowMajor:
        outputArray = array;
        break;
    case Format::ColumnMajor:
        outputArray = array.getArrayWithReversedIndices();
        break;
    default:
        TBTKExit(
            "Exporter::save()",
            "Unknown format '" << static_cast<int>(format) << "'.",
            ""
        );
    }

    std::ofstream fout(filename);
    if(!fout){
        TBTKExit(
            "Exporter::save()",
            "Unable to open file '" << filename << "'.",
            ""
        );
    }
    const std::vector<unsigned int> &ranges = outputArray.getRanges();
    std::vector<unsigned int> begin = ranges;
    std::vector<unsigned int> end = ranges;
    std::vector<unsigned int> increment = ranges;
    for(unsigned int n = 0; n < begin.size(); n++){
        begin[n] = 0;
        increment[n] = 1;
    }
    MultiCounter<unsigned int> counter(begin, end, increment);
    for(counter.reset(); !counter.done(); ++counter)
        write(fout, outputArray[counter]);
    fout.close();
}

inline void Exporter::setFormat(Format format){
    this->format = format;
}

template<typename DataType>
void Exporter::write(std::ofstream &stream, const DataType &value) const{
    stream << value << "\n";
}

template<>
inline void Exporter::write<std::complex<double>>(
    std::ofstream &stream,
    const std::complex<double> &value
) const{
    stream << real(value) << "\n";
    stream << imag(value) << "\n";
}

template<>
inline void Exporter::write<SpinMatrix>(
    std::ofstream &stream,
    const SpinMatrix &value
) const{
    switch(format){
    case Format::RowMajor:
        write(stream, value.at(0, 0));
        write(stream, value.at(0, 1));
        write(stream, value.at(1, 0));
        write(stream, value.at(1, 1));
        break;
    case Format::ColumnMajor:
        write(stream, value.at(0, 0));
        write(stream, value.at(1, 0));
        write(stream, value.at(0, 1));
        write(stream, value.at(1, 1));
        break;
    default:
        TBTKExit(
            "Exporter::write()",
            "This should never happen, contact the developer.",
            ""
        );
    }
}

}; //End of namesapce TBTK

#endif