/*
 *  ******************************************************************************
 *  *
 *  *
 *  * This program and the accompanying materials are made available under the
 *  * terms of the Apache License, Version 2.0 which is available at
 *  * https://www.apache.org/licenses/LICENSE-2.0.
 *  *
 *  *  See the NOTICE file distributed with this work for additional
 *  *  information regarding copyright ownership.
 *  * 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.
 *  *
 *  * SPDX-License-Identifier: Apache-2.0
 *  *****************************************************************************
 */

package org.deeplearning4j.nn.conf;

public enum CNN2DFormat implements DataFormat {
    NCHW,
    NHWC;

    /**
     * Returns a string that explains the dimensions:<br>
     * NCHW -> returns "[minibatch, channels, height, width]"<br>
     * NHWC -> returns "[minibatch, height, width, channels]"
     */
    public String dimensionNames(){
        switch (this){
            case NCHW:
                return "[minibatch, channels, height, width]";
            case NHWC:
                return "[minibatch, height, width, channels]";
            default:
                throw new IllegalStateException("Unknown enum: " + this);   //Should never happen
        }
    }
}
